MUmuxinc
Engagement

Get Engagement Hotspots for a Video

Changed on

Returns the engagement hotspots for a video. Hotspots are the most or least engaging moments of the content, each described by a start and end time (in milliseconds) and a score between 0 and 1. Set order_direction to asc to return the least engaging moments (cold spots).

get/data/v1/engagement/videos/{VIDEO_ID}/hotspots

Request

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

Path parameters

VIDEO_IDstring required

ID of the Video, as provided in the video_id metadata field when configuring the player.

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
limitinteger

Maximum number of hotspots to return. If omitted, all hotspots are returned.

order_direction'asc' | 'desc'

Sort order.

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

    • 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