WIwistia
Analytics:Media

Show Media Embed Locations

Retrieve embed location analytics for a video. Returns a list of pages where the video is embedded, ranked by the chosen metric.

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}/embed_locations

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/analytics/medias/{mediaId}/embed_locations
  • 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.

sort_by'plays' | 'loads' | 'engagement_rate' | 'play_rate' | 'played_time' | 'unique_visitors'

The metric to sort embed locations by.

sort_direction'asc' | 'desc'

The sort direction.

embed_urlstring
Example:https://example.com/landing-page

Filter results to a single embed URL. When provided, only analytics for the page matching this URL are returned. The protocol is optional (https is assumed).

per_pageinteger

Number of results to return (max 100).

Headers

X-Wistia-API-Versionstring required

Response

Success response with embed location analytics.

embed_domainstring nullable

The domain where the video is embedded.

embed_pathstring nullable

The path on the domain where the video is embedded.

embed_urlstring nullable

The full URL where the video is embedded.

page_titlestring nullable

The title of the page where the video is embedded.

loadsinteger nullable

The number of video loads from this location.

unique_loadsinteger nullable

The number of unique video loads from this location (one per visitor session).

playsinteger nullable

The number of video plays from this location.

unique_playsinteger nullable

The number of unique video plays from this location (one per visitor session).

play_ratenumber float nullable

The play rate from this location (between 0 and 1).

played_timenumber float nullable

Total time spent watching from this location in seconds.

engagement_ratenumber float nullable

The average engagement rate from this location (between 0 and 1).

unique_visitorsinteger nullable

The number of unique visitors from this location.

cta_conversion_ratenumber float nullable

The CTA conversion rate from this location (between 0 and 1).

Changes

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