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