Show Media Traffic Breakdown
get_media_traffic_breakdownRetrieve a video's traffic breakdown analytics grouped by UTM campaign, source, medium, referrer domain, or viewer screen size to analyze audience sources.
Instructions
Retrieve traffic breakdown analytics for a video, grouped by a specified dimension such as UTM campaign, UTM source, UTM medium, referrer domain, or viewer screen size.
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 to sort results by. | 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. | |
| group_by | Yes | The dimension to group traffic data by. | |
| media_id | Yes | The hashed ID of the video. | |
| per_page | No | Number of results to return (max 100). | |
| 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. | |
| sort_direction | No | The sort direction. | desc |