Skip to main content

GET Video Graph Metrics

Overview


The following table provides essential details about the GET method for retrieving video graph metrics.

GET Video Graph Metric
MethodGET
URL or Endpoint/api/v2/projects/projectId/video/analytics/graph
HeadersAuthorization
Parametersmetric, videoId, isLive, intervalType, startDate, endDate, items, projectId
BodyNot Applicable

The following table describes the URL parameter for projectId:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique identifier for the project.

The table below provides details about each query parameter:

Parameter NameMandatoryTypeDescription
metricNointeger($int32)The metric to be used for the video graph. Available values are: 0, 1, 2, 3, 4, 5.
videoIdNostringUnique identifier of the video.
isLiveNobooleanA boolean indicating whether the video is live.
intervalTypeNointeger($int32)The type of interval for the graph data. Available values are: 0, 1, 2, 3, 4, 5.
startDateNostring($date-time)The start date for the graph data you wish to retrieve.
endDateNostring($date-time)The end date for the graph data you wish to retrieve.
itemsNointeger($int32)The number of items to include in the graph.
projectIdYesstringThe unique identifier for the project.

Request Body

This GET request does not contain a request body.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"graphResult": [
{
"result": 0,
"date": "2024-08-16T14:07:20.712Z"
}
],
"total": 0
},
"resultInfo": "string",
"statusCode": 0
}

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

Field NameTypeDescription
successbooleanIndicates whether the request was successful.
errorsarray[string]A list of errors that occurred during the request.
messagesarray[string]A list of messages returned by the backend.
resultobjectContains the graph data and total count.
graphResultarray[object]An array containing the graph data points.
resultinteger($int32)The value of the metric at the specified date.
datestring($date-time)The date and time of the data point.
totalinteger($int32)The total number of data points in the result.
resultInfostringAdditional information about the result.
statusCodeinteger($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