Stats:Media

Show Media Engagement

Retrieve engagement data for a video. This endpoint provides engagement data for a specific video identified by its media-id.

Requires api token with one of the following permissions

Read detailed stats

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the view-stats permission on this media can also be used.

get/stats/medias/{mediaId}/engagement

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/stats/medias/{mediaId}/engagement
  • Auth
    HTTP bearer

Path parameters

mediaIdstring required

The hashed ID or numeric ID of the media (e.g., "4d23503f70" or "22570")

The hashed ID or ID of the video for which you want to retrieve engagement data.

Headers

X-Wistia-API-Versionstring required

Response

Success response with the engagement data of the video.

engagementnumber float

The percentage of the video that was viewed, averaged across all viewing sessions.

engagement_datainteger[]

An array for creating an engagement graph.

rewatch_datainteger[]

An array for creating the rewatch block on an engagement graph.

Changes

No recorded changes to this operation across all 1 revision of this API.