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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The hashed ID of the video.

Query Params
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.

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.

string
enum
required

The time granularity for the timeseries data.

Allowed:
string
enum
Defaults to plays

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

Allowed:
string

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).

integer
1 to 100
Defaults to 5

Number of top embed locations per time bucket (max 100). Remaining locations are aggregated into an "All other" entry.

Headers
string
required
Defaults to 2026-09
Responses

404

Media not found or does not belong to account

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json