WIwistia
Analytics:Account

Show Account Embed Locations

Retrieve embed location analytics for the entire account. Returns a list of domains where the account's media are 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 account authorization granting the view-stats permission can also be used.

get/analytics/account/embed_locations

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/analytics/account/embed_locations
  • Auth
    HTTP bearer

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.

per_pageinteger

Number of results to return (max 100).

Headers

X-Wistia-API-Versionstring required

Response

Success response with embed location analytics for the account.

embed_domainstring nullable

The domain where the account's media are embedded.

media_countinteger nullable

The number of distinct media embedded on this domain.

loadsinteger nullable

The number of media loads from this domain.

playsinteger nullable

The number of media plays from this domain.

play_ratenumber float nullable

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

played_timenumber float nullable

Total time spent watching from this domain in seconds.

engagement_ratenumber float nullable

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

unique_visitorsinteger nullable

The number of unique visitors from this domain.

Changes

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