List instances in one video
govtube_list_video_instancesRead-onlyIdempotent
Page through one video's matches by passage, in time order.
A passage is a run of instances whose excerpts overlap, shown as one quote. `offset` and `limit` count
passages; `next_offset` is null on the last page. `passage_count` and `instance_count` cover the whole
video. With detail="full", `instances` also lists every instance of the page one by one.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Passages per page, 1 to 100. Default 10, or 20 with detail="full". | |
| query | Yes | The same query as the search. | |
| detail | No | compact (default): small pages, passages only. full: the larger pages of the REST API (default 10 videos x 5), with every instance listed one by one as well as in passages. | compact |
| offset | No | Passages to skip; use next_offset from the previous page. | |
| speaker | No | Bioguide ID of a member of Congress, e.g. 'C001053' (Rep. Tom Cole). Matches speakers a person has confirmed. Names matched only from the on-screen caption are left out (the result counts them in unreviewed_excluded) unless include_unreviewed is true. Omit to search everyone. | |
| video_id | Yes | video_id from a search result. | |
| include_unreviewed | No | With speaker: also return moments where that person was named from the on-screen caption and nobody has reviewed the name yet. They are labelled 'matched from on-screen name, not reviewed'; say so when you quote them. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | Yes | ||
| video | Yes | ||
| offset | Yes | ||
| rights | Yes | ||
| passages | Yes | ||
| instances | No | ||
| next_offset | Yes | ||
| more_passages | Yes | ||
| passage_count | Yes | ||
| instance_count | Yes | ||
| unreviewed_excluded | No |