Video API, REST: Episode.list
List episodes for stream or line.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/episodes
Query parameters
Parameter | Description |
---|---|
streamId | ID of the stream. |
lineId | ID of the line. |
pageSize | The maximum number of the results per page to return. Default value: 100. |
pageToken | Page token for getting the next page of the result. |
orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: |
Response
HTTP Code: 200 - OK
{
"episodes": [
{
"id": "string",
"streamId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"startTime": "string",
"finishTime": "string",
"dvrSeconds": "string",
"visibilityStatus": "string",
"createdAt": "string",
"updatedAt": "string",
// `episodes[]` includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": {},
"authSystemAccess": {},
// end of the list of possible fields`episodes[]`
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
episodes[] | object List of episodes for specific parent_id. |
episodes[]. id |
string ID of the episode. |
episodes[]. streamId |
string ID of the stream. Optional, empty if the episode is linked to the line |
episodes[]. lineId |
string ID of the line. Optional, empty if the episode is linked to the stream |
episodes[]. title |
string Channel title. |
episodes[]. description |
string Channel description. |
episodes[]. thumbnailId |
string ID of the thumbnail. |
episodes[]. startTime |
string (date-time) Episode start time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
episodes[]. finishTime |
string (date-time) Episode finish time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
episodes[]. dvrSeconds |
string (int64) Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
episodes[]. visibilityStatus |
string |
episodes[]. createdAt |
string (date-time) Time when episode was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
episodes[]. updatedAt |
string (date-time) Time of last episode update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
episodes[]. publicAccess |
object Episode is available to everyone. episodes[] includes only one of the fields publicAccess , authSystemAccess |
episodes[]. authSystemAccess |
object Checking access rights using the authorization system. episodes[] includes only one of the fields publicAccess , authSystemAccess |
nextPageToken | string Token for getting the next page. |