WIwistia
Analytics:Media

Show Media Embed Locations Timeseries

Retrieve timeseries analytics for a video broken down by embed location. Returns an array of timestamped buckets, each containing metrics for the top embed locations (ranked by the chosen metric) plus an "All other" entry aggregating the remaining locations.

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_timeseries

Request

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

granularity'daily' | 'weekly' | 'monthly' required

The time granularity for the timeseries data.

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

The metric used to rank and select the top embed locations.

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 top embed locations per time bucket (max 100). Remaining locations are aggregated into an "All other" entry.

Headers

X-Wistia-API-Versionstring required

Response

Success response with embed location timeseries data.

timestampstring date-time

The start of the time bucket in ISO 8601 format.

Changes

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