Video Engagement Data
Our Video REST APIs give you access to data that makes up the Chartbeat Video Dashboard. Make an HTTP GET request to the endpoints below to return data encoded in JSON.
Video Engagement Data API endpoints are usable only to customers with our Video add-on integrated.
Top Video
GET
https://api.chartbeat.com/live/video/videos/v1/
This live API call returns the top videos on your site.
Query Parameters
Name | Type | Description |
---|---|---|
apikey | string | NOTE: Your API key should no longer be set as a query param; instead, pass it in the HTTP header |
host | string | The site ID of the Site you are querying, prepended with video@ (e.g. video@mysite.com) |
limit | integer | 20 is the default limit of videos to return, but this can be increased or decreased. |
Video Metrics
GET
https://api.chartbeat.com/live/metrics/
This call gives detailed information for a specific video. If no video path is specified, all metrics reflect the top results for the aggregate of all videos.
Query Parameters
Name | Type | Description |
---|---|---|
apikey | string | Your API key. |
host | string | The site ID of the Site you are querying, prepended with video@ (e.g. video@mysite.com). |
names | string | Can be a comma-delineated list of any of the metrics in the table below. |
path | string | The path that is being passed to Chartbeat to identify the video (Not the path of the page the video is on). |
Optional "names" values | Metric Definitions |
| Video length (in milliseconds) |
| The video title |
| Path of the page(s) the video is on |
| Host domain of the page(s) where the video is being played |
| Array of the number of visitors in different video states in the format: [unplayed, playing, paused, completed] |
Last updated