Skip to main content

GET Video Key Moments Graph

Overview


Returns the key moments graph of a video: how many times each second of the video has been watched over the video's whole lifetime. Use it to see which parts viewers watch most, replay or skip.

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

GET Key Moments Graph Data
MethodGET
URL or Endpoint/api/v2/projects/projectId/video/analytics/keyMoments/graph/videoId
HeadersAuthorization
ParametersvideoId, projectId
BodyNot Applicable

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

projectId and videoId URL Parameters
URL Parameter NameprojectId, videoId
MandatoryYes
Typestring
DescriptionUnique identifiers for the project and video, respectively.

The table below provides details about each query parameter:

Parameter NameMandatoryTypeDescription
intervalType Deprecated since Nov 9, 2026NointegerIgnored. The key moments graph always shows all-time data. Can be removed from requests.
startDate Deprecated since Nov 9, 2026Nostring($date-time)Ignored. The key moments graph always shows all-time data. Can be removed from requests.
endDate Deprecated since Nov 9, 2026Nostring($date-time)Ignored. The key moments graph always shows all-time data. Can be removed from requests.

These query parameters are deprecated. They are still accepted but ignored, and will be removed later. Because the key moments graph always shows all-time data, the date range no longer applies.

What the Graph Shows​

  • All time: the graph covers every play of the video, from its first play until now.
  • Every play counts: each value is how many times that second was watched. Replays count again, so one viewer can add more than 1, and plays from every player that shows the video are included.
  • Points: a video shorter than 500 seconds has one point per second, from second 0 to the end of the video. A video of 500 seconds or longer has one point every 100 seconds (0, 100, 200 and so on), with the average of that block, rounded up.
  • No plays: seconds that nobody watched return 0. A live video returns a single point at second 0.

Request Body​

This GET request does not contain a request body.

Response​

{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"videoSeconds": 0,
"views": 1240
},
{
"videoSeconds": 1,
"views": 1236
},
{
"videoSeconds": 2,
"views": 1229
}
],
"resultInfo": null,
"statusCode": 200
}

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.
resultarray[object]One point per second of the video, or per 100 seconds for videos of 500 seconds or longer.
videoSecondsinteger($int32)The second of the video, starting at 0. For videos of 500 seconds or longer, the first second of a 100-second block.
viewsinteger($int32)How many times this second of the video was watched over the video's whole lifetime, by all players. Replays count again. For a 100-second block, the average per second, rounded up.
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 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