MUmuxinc
Engagement

Get Engagement Heatmap for a Playback ID

Changed on

Returns the engagement heatmap for a playback ID. The heatmap is an array of per-bucket engagement values across the content timeline, where the number of buckets scales with the content duration. Each value represents how engaged viewers were with that portion of the content. This only covers views for this specific playback ID; to analyze the entire asset across all of its playback IDs, use the asset ID or video ID endpoint instead.

get/data/v1/engagement/playback-ids/{PLAYBACK_ID}/heatmap

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

PLAYBACK_IDstring required

A Playback ID for the asset.

Query parameters

timeframestring[]

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).

Accepted formats are...

  • array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
  • duration string e.g. timeframe[]=24:hours or timeframe[]=7:days

Response

OK

total_row_countinteger nullable required
timeframeinteger[] required

Changes

  • 99c1d509dcbbRevision changes
    • warning

      deleted the query request parameter timeframe[]

    • info

      added the new optional query request parameter timeframe

  • 4fb3ee354107Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from 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 required property / to the response with the status