Skip to main content

GET Video Analytics

Overview


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

GET Video Analytics
MethodGET
URL or Endpoint/api/projects/projectId/analytics/videos/videoId
HeadersAuthorization
ParametersprojectId, videoId
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
videoIdYesstringUnique 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 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.
playNumberinteger($int32)Returns the number of views of the video
embedNumberinteger($int32)Indicates the amount of times the video was embedded.
completesNumberinteger($int32)Indicates the amount of times the video was watched completely.
uniqueViewersNumberinteger($int32)Indicates the amount of unique viewers of the video.
timesWatchedPerViewerinteger($int32)Indicates the amount of times the video was watched per viewer.
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.

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