List a dataset version's episodes

Request

List the episodes in a dataset version.

Each episode is returned at the version used by that dataset version. Time filters apply to those episode versions.

Security

ApiKey(Required scopes: datasets.list)

Path

idstringrequired

Dataset ID

versionNumberstring^[0-9]+$required

Version number

Query

sortBystring

Field to sort episodes by. addedAt is when the episode joined the dataset. Defaults to addedAt.

Default:"addedAt"

Enum:"addedAt""createdAt""startTime""endTime"

sortOrderstring

Sort order for the sortBy field

Enum:"asc""desc"

limitnumber, [ 0 .. 2000 ]

Maximum number of items to return

Default:2000

offsetinteger, >= 0deprecated

Number of items to skip before returning the results. Deprecated; use cursor instead. When offset is omitted or zero, results use cursor pagination and limit defaults to 2000. A limit of 0 returns no results or continuation cursor. A nonzero offset uses legacy offset pagination and does not return a cursor header. Do not combine a nonzero offset with cursor.

Default:0

cursorstring

Opaque cursor from the fg-pagination-next-cursor or, where supported, fg-pagination-previous-cursor response header.

startstring, (date-time)

Start of the range to match against episode time windows. Episodes that overlap the range are included. Provide both start and end.

endstring, (date-time)

End of the range to match against episode time windows. Episodes that overlap the range are included. Provide both start and end.

hasMissingRecordingsboolean

Filter episodes by whether a member recording is no longer available. true returns only episodes with at least one missing recording. false returns only episodes whose recordings are all available. Omit to return all episodes. A recording counts as unavailable once no primary site holds data for it.

recordingIdstring, non-empty

Filter to episodes containing this recording display ID.

propertiesQuerystring

Filter custom properties at the selected episode version using space-separated key/value terms, for example owner:ana status:accepted. Terms are combined with AND. Quote values containing spaces, for example task:"fold towel". Property filtering does not require include=properties; use that parameter to return the values in the response.

includeArray of strings

Comma-separated list of optional related data to include on each episode.

Items Enum:"recordings""creationContext""properties"

Payload

// No request payload

Responses

List of dataset episodes

Headers

fg-pagination-next-cursorstring

Opaque cursor to supply as cursor on the next request when more results are available.

fg-pagination-previous-cursorstring

Opaque cursor to supply as cursor to retrieve the previous page in the same display order.

Bodyapplication/json

episodesArray of objects(DatasetEpisodeResponse)required

Response

{
  "episodes": [
    { … }
  ]
}