Analytics:Webinar

Show Webinar Analytics

Retrieve aggregate analytics for a webinar. This endpoint provides Bottler-powered analytics including registrations, attendance, engagement, chat activity, and poll results.

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}

Request

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

Path parameters

webinarIdstring required

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

The hashed ID of the webinar.

Query parameters

include_post_eventboolean

Whether to include on-demand viewing data after the live event ended.

post_event_start_datestring date

Start date for the post-event analytics period in ISO 8601 format (YYYY-MM-DD). Inclusive — the range starts at the beginning of this date. Only used when include_post_event is true.

post_event_end_datestring date

End date for the post-event analytics period in ISO 8601 format (YYYY-MM-DD). Exclusive — the range ends before the beginning of this date. Only used when include_post_event is true.

Headers

X-Wistia-API-Versionstring required

Response

Success response with aggregate analytics for the webinar.

registrationsinteger nullable

The total number of registrations for the webinar.

imported_registrationsinteger nullable

The number of registrations imported from external sources.

on_demand_registrationsinteger nullable

The number of registrations for on-demand viewing.

imported_on_demand_registrationsinteger nullable

The number of on-demand registrations imported from external sources.

total_watch_timeinteger nullable

Total watch time across all attendees in seconds.

average_watch_timeinteger nullable

Average watch time per attendee in seconds.

attendanceinteger nullable

The total number of attendees who joined the live event.

chatted_attendeesinteger nullable

The number of attendees who sent at least one chat message.

engagement_ratenumber float nullable

The average engagement rate for attendees (between 0 and 1).

chatsinteger nullable

The total number of chat messages sent during the event.

currently_watchinginteger nullable

The number of viewers currently watching (0 for completed events).

engaged_attendeesinteger nullable

The number of attendees who were actively engaged.

impressionsinteger nullable

The total number of registration page impressions.

on_demand_impressionsinteger nullable

The number of on-demand page impressions.

on_demand_playsinteger nullable

The number of on-demand video plays.

on_demand_engagement_ratenumber float nullable

The engagement rate for on-demand viewers (between 0 and 1).

event_timeinteger nullable

The duration of the live event in seconds.

qa_questionsinteger nullable

The total number of Q&A questions asked during the event.

Changes

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