GET Live Video Active Screen History

Overview

---

The table below provides key details about the GET method for retrieving active screen history of a live video.

GET Live Video Active Screen History
Method	GET
URL or Endpoint	/api/live-videos/projectId/active-screen-history
Headers	Authorization
Parameters	videoId,startDate, endDate, projectId
Body	Not applicable

The description of the URL parameter is as follows:

videoId URL Parameter
URL Parameter Name	videoId
Mandatory	Yes
Type	string
Description	Unique Id of the live video.

startDate URL Parameter
URL Parameter Name	startDate
Mandatory	No
Type	string($date-time)
Description	Start date and time when the live video begins streaming.

endDate URL Parameter
URL Parameter Name	endDate
Mandatory	No
Type	string($date-time)
Description	End date and time when an action is triggered

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

Request Body

This method does not require the request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "name": "string",
      "switchStartTime": "2024-11-13T13:42:45.075Z",
      "switchEndTime": "2024-11-13T13:42:45.075Z"
    }
  ],
  "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	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	array[] of objects	Contains the result data, such as name, switchStartTime, and switchEndTime.
name	string	Name of the result.
switchStartTime	string (ISO 8601 date format)	The start time of the switch event.
switchEndTime	string (ISO 8601 date format)	The end time of the switch event.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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