GET Video Key Moments Card Values

Overview

---

The following table provides essential details about the GET method for retrieving key moments card data for a video.

GET Key Moments Card Data
Method	GET
URL or Endpoint	/api/v2/projects/projectId/video/analytics/keyMoments/cards/videoId
Headers	Authorization
Parameters	metric, isLive, intervalType, startDate, endDate, items, videoId, projectId
Body	Not Applicable

The following table describes the URL parameters for projectId and videoId:

projectId and videoId URL Parameters
URL Parameter Name	projectId, videoId
Mandatory	Yes
Type	string
Description	Unique identifiers for the project and video, respectively.

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 key moments card data. Available values are: 0, 1, 2, 3, 4, 5.
isLive	No	boolean	A boolean indicating whether the video is live.
intervalType	No	integer($int32)	The type of interval for the card data. Available values are: 0, 1, 2, 3, 4, 5.
startDate	No	string($date-time)	The start date for the card data you wish to retrieve.
endDate	No	string($date-time)	The end date for the card data you wish to retrieve.
items	No	integer($int32)	The number of items to include in the card data.
videoId	Yes	string	The unique identifier of the video.
projectId	Yes	string	The unique identifier for the project.

tip

Click here to see more for metrics and interval types.

Request Body

This GET request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "averageViewDuration": 0,
    "averageViewDurationPercentage": 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 key moments card data.
averageViewDuration	integer($int32)	The average duration of views for the video.
averageViewDurationPercentage	integer($int32)	The average percentage of the video viewed.
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 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