Get Video heatmap data

Returns raw heatmap data for the video, used to render the attention heatmap on the player timeline. Returns an empty string if the library has heatmaps disabled or no heatmap data exists yet.

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

Get Video heatmap data

cURL

curl --request GET \
  --url https://video.bunnycdn.com/library/{libraryId}/videos/{videoId}/play/heatmap

200

{
  "video": {
    "videoLibraryId": 123,
    "guid": "<string>",
    "title": "<string>",
    "dateUploaded": "2023-11-07T05:31:56Z",
    "views": 123,
    "isPublic": true,
    "length": 123,
    "status": 0,
    "framerate": 123,
    "width": 123,
    "height": 123,
    "outputCodecs": "<string>",
    "thumbnailCount": 123,
    "encodeProgress": 123,
    "storageSize": 123,
    "hasMP4Fallback": true,
    "averageWatchTime": 123,
    "totalWatchTime": 123,
    "description": "<string>",
    "rotation": 123,
    "availableResolutions": "<string>",
    "captions": [
      {
        "srclang": "<string>",
        "label": "<string>",
        "version": 123
      }
    ],
    "collectionId": "<string>",
    "thumbnailFileName": "<string>",
    "thumbnailUrl": "<string>",
    "thumbnailBlurhash": "<string>",
    "category": "<string>",
    "chapters": [
      {
        "title": "<string>",
        "start": 123,
        "end": 123
      }
    ],
    "moments": [
      {
        "label": "<string>",
        "timestamp": 123
      }
    ],
    "metaTags": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ],
    "transcodingMessages": [
      {
        "timeStamp": "2023-11-07T05:31:56Z",
        "level": 0,
        "issueCode": 0,
        "message": "<string>",
        "value": "<string>"
      }
    ],
    "jitEncodingEnabled": true,
    "smartGenerateStatus": 0,
    "smartGenerateFeaturesStatus": {
      "title": 0,
      "description": 0,
      "chapters": 0,
      "moments": 0
    },
    "hasOriginal": true,
    "originalHash": "<string>",
    "hasHighQualityPreview": true
  },
  "libraryName": "<string>",
  "pullZoneId": 123,
  "captionsPath": "<string>",
  "seekPath": "<string>",
  "thumbnailUrl": "<string>",
  "fallbackUrl": "<string>",
  "videoPlaylistUrl": "<string>",
  "originalUrl": "<string>",
  "previewUrl": "<string>",
  "controls": "<string>",
  "enableDRM": true,
  "drmVersion": 123,
  "playerKeyColor": "<string>",
  "vastTagUrl": "<string>",
  "viAiPublisherId": "<string>",
  "captionsFontSize": 123,
  "captionsFontColor": "<string>",
  "captionsBackground": "<string>",
  "uiLanguage": "<string>",
  "allowEarlyPlay": true,
  "tokenAuthEnabled": true,
  "enableMP4Fallback": true,
  "showHeatmap": true,
  "fontFamily": "<string>",
  "playbackSpeeds": "<string>",
  "widevineMinClientSecurityLevel": 123,
  "widevineEmeRobustness": "<string>",
  "widevineSdOnlyForL3": true,
  "maxSoftwareWidevineResolution": 123,
  "zoneTier": 123,
  "isPlayable": true,
  "isPlaylistPlayable": true,
  "preferredPlaybackSource": "None",
  "rememberPlayerPosition": true,
  "customCss": "<string>",
  "exposeVideoMetadata": true,
  "enableCompactControls": true
}

Path Parameters

libraryId · integer<int64> · required

The ID of the video library.

videoId · string · required

The GUID of the video.

Query Parameters

token · string | null · default: ""

Signed access token, required when the library has token authentication enabled.

expires · integer<int64> · default: 0

Unix timestamp (seconds) the token is valid until, required when the library has token authentication enabled.

Response

200

application/json

The heatmap data of the requested video

video · object | null

Video data.

Show child attributes

libraryName · string | null

The name of the video library.

pullZoneId · integer<int64>

The pull zone ID backing the video library's CDN delivery.

captionsPath · string | null

CDN URL of the directory containing the video's caption (.vtt) files.

seekPath · string | null

CDN URL of the directory containing the video's seek/scrub thumbnail sprites.

thumbnailUrl · string | null

CDN URL of the video's thumbnail image.

fallbackUrl · string | null

CDN URL prefix for the video's MP4 fallback renditions.

videoPlaylistUrl · string | null

CDN URL of the video's HLS master playlist.

originalUrl · string | null

CDN URL of the original uploaded source file. Only populated when the library allows early/original playback.

previewUrl · string | null

CDN URL of the video's animated preview (scrub thumbnail).

controls · string | null

Comma-separated list of player control identifiers enabled for this library.

enableDRM · boolean

Whether DRM protection is enabled for this video.

drmVersion · integer<int32>

DRM protection tier applied to this video, as an integer cast of the Basic/Enterprise tier enum. Only relevant when EnableDRM is true.

playerKeyColor · string | null

The player's accent/key color, as a CSS color value.

vastTagUrl · string | null

VAST ad tag URL used to serve ads in the player; empty when ads are disabled.

viAiPublisherId · string | null

Publisher ID for the vi.ai advertising integration; ads are enabled in the player when this is non-empty.

captionsFontSize · integer<int32>

Caption font size in pixels.

captionsFontColor · string | null

CSS color value for the caption text.

captionsBackground · string | null

CSS color value for the caption background.

uiLanguage · string | null

Locale code for the player's UI language (e.g. "en").

allowEarlyPlay · boolean

Whether the video can be played from the original source file before encoding has finished.

tokenAuthEnabled · boolean

Whether the library's CDN delivery requires signed URLs for playback assets (segments, manifests, thumbnails, etc.). This is a separate setting from whether this endpoint itself required a token to return data.

enableMP4Fallback · boolean

Whether MP4 fallback renditions are available for players that cannot use HLS.

showHeatmap · boolean

Whether the attention heatmap is enabled for this library's player.

fontFamily · string | null

CSS font-family value used by the player.

playbackSpeeds · string | null

Comma-separated list of playback speed multipliers offered to the viewer (e.g. "0.5,1,1.5,2").

widevineMinClientSecurityLevel · integer<int32> | null

Minimum required Widevine client security level (1-3). Ignored (always null here) when WidevineSdOnlyForL3 is enabled, since that setting takes precedence.

widevineEmeRobustness · string | null

EME robustness string corresponding to WidevineMinClientSecurityLevel (e.g. "SW_SECURE_CRYPTO", "HW_SECURE_DECODE"); null when no minimum level applies.

widevineSdOnlyForL3 · boolean

When true, Widevine L3 (software-only) clients are capped to SD playback while stronger clients play at full quality; overrides WidevineMinClientSecurityLevel when both are set.

maxSoftwareWidevineResolution · integer<int32> | null

Maximum vertical resolution allowed for software (L3) Widevine clients when WidevineSdOnlyForL3 is enabled; null otherwise.

zoneTier · integer<int32> | null

Pull zone tier associated with this video library (integer enum value).

isPlayable · boolean

Determines if the video is currently playable using either playlist or original source.

isPlaylistPlayable · boolean

Determines if the HLS playlist is currently playable.

preferredPlaybackSource · None · enum<string> Playlist · enum<string> Original · enum<string>

Preferred playback source for the current video state.

Available options: None

rememberPlayerPosition · boolean

Whether the player resumes from the viewer's last watched position.

customCss · string | null

Custom CSS injected into the player. Only populated when the caller explicitly requests it.

exposeVideoMetadata · boolean

Whether JSON-LD structured data (schema.org VideoObject markup) is rendered for this video, e.g. for SEO.

enableCompactControls · boolean

Whether the player uses a compact control bar layout.