GET Video Graph Metrics
Overview
The following table provides essential details about the GET
method for retrieving video graph metrics.
GET Video Graph Metric | |
---|---|
Method | GET |
URL or Endpoint | /api/v2/projects/projectId /video/analytics/graph |
Headers | Authorization |
Parameters | metric, videoId, isLive, intervalType, startDate, endDate, items, projectId |
Body | Not Applicable |
The following table describes the URL parameter for projectId
:
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique identifier for the project. |
The table below provides details about each query parameter:
Parameter Name | Mandatory | Type | Description |
---|---|---|---|
metric | No | integer($int32) | The metric to be used for the video graph. Available values are: 0, 1, 2, 3, 4, 5. |
videoId | No | string | Unique identifier of the video. |
isLive | No | boolean | A boolean indicating whether the video is live. |
intervalType | No | integer($int32) | The type of interval for the graph data. Available values are: 0, 1, 2, 3, 4, 5. |
startDate | No | string($date-time) | The start date for the graph data you wish to retrieve. |
endDate | No | string($date-time) | The end date for the graph data you wish to retrieve. |
items | No | integer($int32) | The number of items to include in the graph. |
projectId | Yes | string | The 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 Name | Type | Description |
---|---|---|
success | boolean | Indicates whether the request was successful. |
errors | array[string] | A list of errors that occurred during the request. |
messages | array[string] | A list of messages returned by the backend. |
result | object | Contains the graph data and total count. |
graphResult | array[object] | An array containing the graph data points. |
result | integer($int32) | The value of the metric at the specified date. |
date | string($date-time) | The date and time of the data point. |
total | integer($int32) | The total number of data points in the result. |
resultInfo | string | Additional information about the result. |
statusCode | integer($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