Video API, REST: Video.list
List videos for channel.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/videos
Query parameters
Parameter | Description |
---|---|
channelId | ID of the channel. |
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
{
"videos": [
{
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "string",
"duration": "string",
"visibilityStatus": "string",
"createdAt": "string",
"updatedAt": "string",
"labels": "object",
"tusd": {
"url": "string"
},
// `videos[]` includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": {},
"authSystemAccess": {},
// end of the list of possible fields`videos[]`
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
videos[] | object |
videos[]. id |
string ID of the video. |
videos[]. channelId |
string ID of the channel where the video was created. |
videos[]. title |
string Video title. |
videos[]. description |
string Video description. |
videos[]. thumbnailId |
string ID of the thumbnail. |
videos[]. status |
string Video status.
|
videos[]. duration |
string Video duration. Optional, may be empty until the transcoding result is ready. |
videos[]. visibilityStatus |
string Video visibility status.
|
videos[]. createdAt |
string (date-time) Time when video 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). |
videos[]. updatedAt |
string (date-time) Time of last video 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). |
videos[]. labels |
object Custom labels as |
videos[]. tusd |
object Upload video using the tus protocol. |
videos[]. tusd. url |
string URL for uploading video via the tus protocol. |
videos[]. publicAccess |
object Video is available to everyone. videos[] includes only one of the fields publicAccess , authSystemAccess |
videos[]. authSystemAccess |
object Checking access rights using the authorization system. videos[] includes only one of the fields publicAccess , authSystemAccess |
nextPageToken | string Token for getting the next page. |