GET Video Heatmap
Overview
Returns engagement heatmap data for a specific video. The video timeline is divided into equal segments, and each segment receives a score from 0 to 1 representing its relative viewer engagement. A score of 1 marks the most-engaged segment; all other scores are relative to it. Engagement is measured by how many viewers actively played through each segment — segments where more viewers watched, or where viewers replayed, will score higher. Segments with no viewing activity score 0.
| GET Video Heatmap | |
|---|---|
| Method | GET |
| URL or Endpoint | /stats/video/videoId/heatmap.json |
| Headers | Not Applicable |
| Parameters | videoId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
videoId | Yes | string | Unique ID of the video. |
Request Body
The request does not contain a request body.
Response
{
"items": [
{
"videoSeconds": 0,
"score": 0.0
}
]
}
Information about the fields that appear when you receive the response are displayed in the table below.
Top-Level Properties
| Field Name | Type | Description |
|---|---|---|
items | array[object] | Collection of heatmap data points across the video timeline. |
items Properties
| Field Name | Type | Description |
|---|---|---|
videoSeconds | integer | The position in seconds within the video timeline. |
score | double | Relative engagement score between 0 and 1. A value of 1 represents the most-engaged segment; all other scores are relative to it. Segments with no viewing activity return 0. |
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:
HTTP Status Code 400: Bad Request
HTTP Status Code 500: Internal Server Error