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
Field |
Description |
streamId |
string ID of the stream. Includes only one of the fields |
lineId |
string ID of the line. Includes only one of the fields |
pageSize |
string (int64) The maximum number of the results per page to return. Default value: 100. |
pageToken |
string Page token for getting the next page of the result. |
orderBy |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter expression that filters resources listed in the response. |
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",
// Includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": "object",
"authSystemAccess": "object",
// end of the list of possible fields
"createdAt": "string",
"updatedAt": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
episodes[] |
List of episodes for specific parent_id. |
nextPageToken |
string Token for getting the next page. |
Episode
Field |
Description |
id |
string ID of the episode. |
streamId |
string ID of the stream. Optional, empty if the episode is linked to the line |
lineId |
string ID of the line. Optional, empty if the episode is linked to the stream |
title |
string Channel title. |
description |
string Channel description. |
thumbnailId |
string ID of the thumbnail. |
startTime |
string (date-time) Episode start time. String in RFC3339 To work with values in this field, use the APIs described in the |
finishTime |
string (date-time) Episode finish time. String in RFC3339 To work with values in this field, use the APIs described in the |
dvrSeconds |
string (int64) Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibilityStatus |
enum (VisibilityStatus)
|
publicAccess |
object Episode is available to everyone. Includes only one of the fields Episode access rights. |
authSystemAccess |
object Checking access rights using the authorization system. Includes only one of the fields Episode access rights. |
createdAt |
string (date-time) Time when episode was created. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Time of last episode update. String in RFC3339 To work with values in this field, use the APIs described in the |