WIwistia
Analytics:Webinar

Show Webinar Traffic Breakdown

Retrieve traffic breakdown analytics for a webinar, grouped by a specified dimension such as UTM campaign, UTM source, UTM medium, or referrer domain.

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 webinar can also be used.

get/analytics/webinars/{webinarId}/traffic

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/analytics/webinars/{webinarId}/traffic
  • Auth
    HTTP bearer

Path parameters

webinarIdstring required

The hashed ID of the webinar (e.g., "abc123xyz")

The hashed ID of the webinar.

Query parameters

group_by'utm_campaign' | 'utm_source' | 'utm_medium' | 'referrer_domain' required

The dimension to group traffic data by.

sort_by'registrations' | 'attendees' | 'impressions'

The metric to sort results by.

sort_direction'asc' | 'desc'

The sort direction.

Headers

X-Wistia-API-Versionstring required

Response

Success response with traffic breakdown data.

utm_campaignstring nullable

The UTM campaign value (present when group_by is utm_campaign).

utm_sourcestring nullable

The UTM source value (present when group_by is utm_source).

utm_mediumstring nullable

The UTM medium value (present when group_by is utm_medium).

referrer_domainstring nullable

The referrer domain (present when group_by is referrer_domain).

registrationsinteger nullable

The number of registrations from this traffic source.

attendeesinteger nullable

The number of attendees from this traffic source.

impressionsinteger nullable

The number of registration page impressions from this traffic source.

Changes

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