GET Live Viewers

Overview

---

The following table contains important information about the GET method for retrieving live viewer analytics.

GET Live Viewers
Method	GET
URL or Endpoint	/api/v2/projects/projectId/analytics/liveViewers
Headers	Authorization
Parameters	videoId, endDate, seconds, intervalLength, isLive, projectId
Body	Not Applicable

The following table describes the URL parameter for projectId:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique identifier for the project.

The table below provides details about each query parameter:

Parameter Name	Mandatory	Type	Description
videoId	Yes	string	Unique identifier of the video.
endDate	No	string($date-time)	The end date for the analytics data you wish to retrieve.
seconds	No	integer($int32)	The number of seconds for which to retrieve analytics data.
intervalLength	No	integer($int32)	The length of the interval for which the analytics data is aggregated.
isLive	No	boolean	A boolean indicating whether the video is live.
projectId	Yes	string	The unique identifier for the project.

Request Body

This GET request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "liveViewers": [
      {
        "uniqueViewers": 1,
        "date": "2024-08-16T11:49:15"
      },
      {
        "uniqueViewers": 1,
        "date": "2024-08-16T11:49:30"
      }
    ],
    "total": 1
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Field Name	Type	Description
success	boolean	Indicates whether the request was successful.
errors	array[]	A list of errors that occurred during the request.
messages	array[]	A list of messages returned by the backend.
result	array[Object]	An array containing the analytics result data.
uniqueViewers	integer($int32)	The number of unique viewers.
date	string($date-time)	The date and time of the analytics data.
resultInfo	string	Additional information about the result.
statusCode	integer($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:

• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 404: Result Not Found
• 500: Internal Server Error
• 503: Backend Fetch Failed