GET Video Analytics

Overview

---

The following table contains important information about the GET method in regards to receiving the video analytics.

GET Video Analytics
Method	GET
URL or Endpoint	/api/projects/projectId/analytics/videos/videoId
Headers	Authorization
Parameters	projectId, videoId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
videoId	Yes	string	Unique id of the video.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "playsNumber": 1,
    "embedNumber": 0,
    "completesNumber": 0,
    "uniqueViewersNumber": 1,
    "timeWatchedPerViewer": 340
  },
  "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.
playNumber	integer($int32)	Returns the number of views of the video
embedNumber	integer($int32)	Indicates the amount of times the video was embedded.
completesNumber	integer($int32)	Indicates the amount of times the video was watched completely.
uniqueViewersNumber	integer($int32)	Indicates the amount of unique viewers of the video.
timesWatchedPerViewer	integer($int32)	Indicates the amount of times the video was watched per viewer.
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