Skip to main content

GET Live Videos Paged List

Overview


The table below provides key details about the GET method for retrieving a paged list of Live Videos.

GET Live Videos Paged List
MethodGET
URL or Endpoint/api/v2/projectId/live-videos
HeadersAuthorization
ParametersprojectId, author, search, order, insertedDate, page, take
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
searchNostringSearch for a specific live video
authorNostringAuthor name
orderNostringSpecified the order position of the live video
insertedDateNostring($date-time)Date time
pageNointeger($int32)Current page you want to receive
takeNointeger($int32)Number of live videos you want to receive
projectIdYesstringThe id of the project.

Request Body

The request does not contain a request body.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"currentPage": 0,
"totalPages": 0,
"pageSize": 0,
"totalCount": 0,
"items": [
{
"publicId": "string",
"title": "string",
"author": "string",
"liveVideoAuthor": "string",
"publishDate": "2024-11-22T13:28:03.469Z",
"liveStatus": "string",
"canGoLive": true,
"highlight": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
},
"canCutAndPublish": true,
"isLiveStreaming": true,
"dvrEnabled": true,
"canStopAndCut": true,
"canStopWithoutSaving": true,
"thumbnail": "string"
}
]
},
"resultInfo": "string",
"statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIndicates whether the response is successful. Returns true if successful, otherwise false.
errorsarray[string]A list of error messages, if any.
messagesarray[string]Response messages from the back-end.
resultobjectContains detailed information about the live video results.
currentPageinteger($int32)Specifies the current page number in the paginated list of live videos.
totalPagesinteger($int32)Indicates the total number of pages available in the live videos list.
pageSizeinteger($int32)Defines the maximum number of live videos displayed per page.
totalCountinteger($int32)Total number of live videos across all pages.
itemsarray[object]A list of live video objects with detailed information.
publicIdstringThe public identifier for the live video.
titlestringThe title of the live video.
authorstringThe author of the live video.
liveVideoAuthorstringThe name of the author associated with the live video.
publishDatestring($date-time)The date and time when the live video was published.
liveStatusstringThe current live status of the video.
canGoLiveboolIndicates if the video can be set to live.
highlightobjectAn object containing highlighted data with additional properties.
canCutAndPublishboolIndicates if the video can be edited and published.
isLiveStreamingboolIndicates if the video is currently live streaming.
dvrEnabledboolIndicates if DVR is enabled for the live video.
canStopAndCutboolIndicates if the video can be stopped and cut.
canStopWithoutSavingboolIndicates if the live video can be stopped without saving.
thumbnailstringThe URL of the thumbnail image for the live video.
resultInfostringAdditional information about the result.
statusCodeinteger($int32)The HTTP status code of the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed