GET Video Live Consumption

Overview

---

The following table contains important information about the GET method in regards to receiving video live consumption statistics for a specific project.

GET Video Live Consumption
Method	GET
URL or Endpoint	/api/v1/projects/projectId/dashboard/videoLiveConsumption
Headers	Authorization
Parameters	projectId, intervalLength
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 query parameters is as follows:

Parameter Name	Mandatory	Type	Description
intervalLength	No	integer($int32)	The time interval length (in minutes) for grouping viewer data.

info

If no intervalLength value is provided, the endpoint defaults to returning the video live consumption for the last 24 hours.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "liveViewers": [
      {
        "uniqueViewers": 0,
        "date": "2025-10-29T12:05:38.367Z"
      }
    ],
    "total": 0
  },
  "resultInfo": "string",
  "statusCode": 200
}

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 will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	object	Returns the response object containing live viewers and total values.
liveViewers	array[object]	List of live viewer records for each time interval.
uniqueViewers	integer($int32)	The number of unique viewers during the given time interval.
date	string($date-time)	The timestamp corresponding to the interval.
total	integer($int32)	The total number of unique live viewers for the specified time period.
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