Show Media Embed Locations Timeseries
get_media_embed_locations_timeseriesRetrieve time-series analytics for a video by embed location. Returns timestamped buckets with metrics for top locations plus an aggregated 'All other' entry.
Instructions
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 statsTokens 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.
Read-only account operation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| sort_by | No | The metric used to rank and select the top embed locations. | plays |
| end_date | Yes | End date for the analytics period in ISO 8601 format (YYYY-MM-DD). Exclusive — the range ends before the beginning of this date. | |
| media_id | Yes | The hashed ID of the video. | |
| per_page | No | Number of top embed locations per time bucket (max 100). Remaining locations are aggregated into an "All other" entry. | |
| embed_url | No | 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). | |
| start_date | Yes | Start date for the analytics period in ISO 8601 format (YYYY-MM-DD). Inclusive — the range starts at the beginning of this date. | |
| granularity | Yes | The time granularity for the timeseries data. |