Skip to main content

GET Live Viewers


The following table contains important information about the GET method in regards to receiving the live viewers.

GET Live Viewers
URL or Endpoint/api/projects/projectId/analytics/liveViewers
ParametersprojectId, videoId, andDate, seconds, intervalLength, projectId(query)
BodyNot Applicable

The description of the URL parameter is as follows:

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

The description of the parameters is as follows:

Parameter NameMandatoryTypeDescription
videoIdYesstringA word you want to filter.
endDateNoDATEThe date you want to receive information for.
secondsNointeger($int32)The seconds you want to receive information for.
intervalLengthNointeger($int32)The length of the interval.
projectIdYesstringThe id of the project.

Request Body

The request does not contain a request body.


"success": true,
"errors": [],
"messages": [],
"result": [
"date": "2021-09-13T12:52:45",
"uniqueViewers": 0
"resultInfo": null,
"statusCode": 200

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
dateDateThe date the video was watched.
uniqueViewersinteger($int32)The number of unique viewers.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

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


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