Get Video Heatmap

Returns the attention heatmap for a specific video, showing relative viewer interest across the timeline. May be unavailable if the feature is disabled or there isn’t enough viewing data.

GET /library/{libraryId}/videos/{videoId}/heatmap

Get Video Heatmap

cURL

curl --request GET \
  --url https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap \
  --header 'AccessKey: <api-key>'

import requests

url = "https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap"

headers = {"AccessKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("AccessKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/heatmap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "heatmap": {}
}

Authorizations

AccessKey · string · header · required

AccessKey based authentication

Path Parameters

libraryId · integer<int64> · required

The ID of the video library.

videoId · string · required

The GUID of the video.

Response

200

application/json

The heatmap of the requested video.

heatmap · object | null

Timeline heatmap as segment-index to intensity (0–100). Keys represent consecutive segments from the start of the video; values are normalized so 100 equals the most‑watched segment. Missing segments imply 0.

Show child attributes