WIwistia
Analytics:Media

Show Media Analytics

Retrieve aggregate analytics for a video over a date range. This endpoint provides Bottler-powered analytics including plays, loads, engagement rate, play rate, and conversion metrics.

The date range between start_date and end_date must not exceed 2 years.

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/analytics/medias/{mediaId}

Request

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

Path parameters

mediaIdstring required

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

The hashed ID of the video.

Query parameters

start_datestring date required

Start date for the analytics period in ISO 8601 format (YYYY-MM-DD). Inclusive — the range starts at the beginning of this date.

end_datestring date required

End date for the analytics period in ISO 8601 format (YYYY-MM-DD). Exclusive — the range ends before the beginning of this date.

Headers

X-Wistia-API-Versionstring required

Response

Success response with aggregate analytics for the video.

unique_loadsinteger nullable

The number of unique video loads.

unique_playsinteger nullable

The number of unique video plays.

playsinteger nullable

The total number of video plays.

play_ratenumber float nullable

The percentage of loads that resulted in a play (between 0 and 1).

played_timeinteger nullable

Total time spent watching the video in seconds.

unique_visitorsinteger nullable

The number of unique visitors who loaded the video.

engagement_ratenumber float nullable

The average percentage of the video watched (between 0 and 1).

cta_impressionsinteger nullable

The number of times a call-to-action was shown.

cta_conversionsinteger nullable

The number of times a call-to-action was clicked.

cta_conversion_ratenumber float nullable

The rate of CTA clicks over impressions (between 0 and 1).

form_conversionsinteger nullable

The number of form submissions.

Changes

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