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
Method	GET
URL or Endpoint	/api/v2/projectId/live-videos
Headers	Authorization
Parameters	projectId, author, search, order, insertedDate, page, take
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	No	string	Search for a specific live video
author	No	string	Author name
order	No	string	Specified the order position of the live video
insertedDate	No	string($date-time)	Date time
page	No	integer($int32)	Current page you want to receive
take	No	integer($int32)	Number of live videos you want to receive
projectId	Yes	string	The 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 Name	Type	Description
success	bool	Indicates whether the response is successful. Returns true if successful, otherwise false.
errors	array[string]	A list of error messages, if any.
messages	array[string]	Response messages from the back-end.
result	object	Contains detailed information about the live video results.
currentPage	integer($int32)	Specifies the current page number in the paginated list of live videos.
totalPages	integer($int32)	Indicates the total number of pages available in the live videos list.
pageSize	integer($int32)	Defines the maximum number of live videos displayed per page.
totalCount	integer($int32)	Total number of live videos across all pages.
items	array[object]	A list of live video objects with detailed information.
publicId	string	The public identifier for the live video.
title	string	The title of the live video.
author	string	The author of the live video.
liveVideoAuthor	string	The name of the author associated with the live video.
publishDate	string($date-time)	The date and time when the live video was published.
liveStatus	string	The current live status of the video.
canGoLive	bool	Indicates if the video can be set to live.
highlight	object	An object containing highlighted data with additional properties.
canCutAndPublish	bool	Indicates if the video can be edited and published.
isLiveStreaming	bool	Indicates if the video is currently live streaming.
dvrEnabled	bool	Indicates if DVR is enabled for the live video.
canStopAndCut	bool	Indicates if the video can be stopped and cut.
canStopWithoutSaving	bool	Indicates if the live video can be stopped without saving.
thumbnail	string	The URL of the thumbnail image for the live video.
resultInfo	string	Additional information about the result.
statusCode	integer($int32)	The HTTP status code of the response.

tip

Click here to see more about live or health status.

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