GET Live Viewers

Overview

---

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

GET Live Viewers
Method	GET
URL or Endpoint	/api/projects/projectId/analytics/liveViewers
Headers	Authorization
Parameters	projectId, videoId, andDate, seconds, intervalLength, projectId(query)
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
videoId	Yes	string	A word you want to filter.
endDate	No	DATE	The date you want to receive information for.
seconds	No	integer($int32)	The seconds you want to receive information for.
intervalLength	No	integer($int32)	The length of the interval.
projectId	Yes	string	The id of the project.

Request Body

The request does not contain a request body.

Response

{
  "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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
date	Date	The date the video was watched.
uniqueViewers	integer($int32)	The number of unique viewers.
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