BUbunny
Manage Videos

Get Video heatmap data

Changed on

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

Request

Path parameters

libraryIdinteger required

The ID of the video library.

videoIdstring required

The GUID of the video.

Query parameters

tokenstring nullable

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

expiresinteger

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

Response

The heatmap data of the requested video

libraryNamestring nullable

The name of the video library.

pullZoneIdinteger

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

captionsPathstring nullable

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

seekPathstring nullable

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

thumbnailUrlstring nullable

CDN URL of the video's thumbnail image.

fallbackUrlstring nullable

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

videoPlaylistUrlstring nullable

CDN URL of the video's HLS master playlist.

originalUrlstring nullable

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

previewUrlstring nullable

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

controlsstring nullable

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

enableDRMboolean

Whether DRM protection is enabled for this video.

drmVersioninteger

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

playerKeyColorstring nullable

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

vastTagUrlstring nullable

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

viAiPublisherIdstring nullable

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

captionsFontSizeinteger

Caption font size in pixels.

captionsFontColorstring nullable

CSS color value for the caption text.

captionsBackgroundstring nullable

CSS color value for the caption background.

uiLanguagestring nullable

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

allowEarlyPlayboolean

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

tokenAuthEnabledboolean

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.

enableMP4Fallbackboolean

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

showHeatmapboolean

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

fontFamilystring nullable

CSS font-family value used by the player.

playbackSpeedsstring nullable

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

widevineMinClientSecurityLevelinteger nullable

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

widevineEmeRobustnessstring nullable

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

widevineSdOnlyForL3boolean

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.

maxSoftwareWidevineResolutioninteger nullable

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

zoneTierinteger nullable

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

isPlayableboolean

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

isPlaylistPlayableboolean

Determines if the HLS playlist is currently playable.

rememberPlayerPositionboolean

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

customCssstring nullable

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

exposeVideoMetadataboolean

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

enableCompactControlsboolean

Whether the player uses a compact control bar layout.

Changes

  • 83116184952fRevision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      added subschema #1: Created subschema #2: Uploaded subschema #3: Processing subschema #4: Transcoding subschema #5: Finished subschema #6: Error subschema #7: UploadFailed subschema #8: JitSegmenting subschema #9: JitPlaylistsCreated to the ///////// response property oneOf list for the response status

    • breaking

      added subschema #1: None subschema #2: Playlist subschema #3: Original to the //// response property oneOf list for the response status

    • breaking

      added subschema #1: None subschema #2: Queued subschema #3: InProgress subschema #4: Finished subschema #5: Failed to the ///////// response property oneOf list for the response status

    • breaking

      the /////// response's property type changed from integer to no type for status

    • breaking

      the /////// response's property type changed from integer to no type for status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the 0.00 enum value from the ///////// response property for the response status

    • info

      removed the 0.00 enum value from the ///////// response property for the response status

    • info

      removed the 0.00 enum value from the /////// response property for the response status

    • info

      removed the 0.00 enum value from the /////// response property for the response status

    • info

      removed the 1.00 enum value from the ///////// response property for the response status

    • info

      removed the 1.00 enum value from the ///////// response property for the response status

    • info

      removed the 1.00 enum value from the /////// response property for the response status

    • info

      removed the 1.00 enum value from the /////// response property for the response status

    • info

      removed the 10.00 enum value from the /////// response property for the response status

    • info

      removed the 11.00 enum value from the /////// response property for the response status

    • info

      removed the 2.00 enum value from the ///////// response property for the response status

    • info

      removed the 2.00 enum value from the ///////// response property for the response status

    • info

      removed the 2.00 enum value from the /////// response property for the response status

    • info

      removed the 2.00 enum value from the /////// response property for the response status

    • info

      removed the 3.00 enum value from the ///////// response property for the response status

    • info

      removed the 3.00 enum value from the ///////// response property for the response status

    • info

      removed the 3.00 enum value from the /////// response property for the response status

    • info

      removed the 3.00 enum value from the /////// response property for the response status

    • info

      removed the 4.00 enum value from the ///////// response property for the response status

    • info

      removed the 4.00 enum value from the ///////// response property for the response status

    • info

      removed the 4.00 enum value from the /////// response property for the response status

    • info

      removed the 5.00 enum value from the ///////// response property for the response status

    • info

      removed the 5.00 enum value from the /////// response property for the response status

    • info

      removed the 6.00 enum value from the ///////// response property for the response status

    • info

      removed the 6.00 enum value from the /////// response property for the response status

    • info

      removed the 7.00 enum value from the ///////// response property for the response status

    • info

      removed the 7.00 enum value from the /////// response property for the response status

    • info

      removed the 8.00 enum value from the ///////// response property for the response status

    • info

      removed the 8.00 enum value from the /////// response property for the response status

    • info

      removed the 9.00 enum value from the /////// response property for the response status

    • info

      removed the None enum value from the //// response property for the response status

    • info

      removed the Original enum value from the //// response property for the response status

    • info

      removed the Playlist enum value from the //// response property for the response status