Get webinar participants
GET {{baseUrl}}/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=<string>&include_fields=registrant_id
Returns information about participants from live or past webinars. Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.
Note:
This API might return empty values for participants'
user_name
,
ip_address
,
location
, and
email
responses when the account calls this API.
Prerequisites:
- A Business, Education, or API Plan with Webinar add-on.
- Any legacy HIPAA BAA account .
- No signed HIPAA business associate agreement (BAA).
Scopes:
dashboard_webinars:read:admin
,
dashboard:read:admin
Rate Limit Label
:
HEAVY
Request Params
| Key | Datatype | Required | Description |
| type | string | | The type of webinar to query.
past- All past webinars.live- All live webinars.
This value defaults to live. |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
| include_fields | string | | The additional fields to include in the query.
registrant_id- Includes the webinar registrant's ID. The registrant ID is the webinar registrant's unique ID. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":30,"total_records":"\u003cinteger\u003e","participants":[{"audio_quality":"poor","connection_type":"\u003cstring\u003e","customer_key":"\u003cstring\u003e","data_center":"\u003cstring\u003e","device":"H.323/SIP","domain":"\u003cstring\u003e","email":"\u003cstring\u003e","from_sip_uri":"\u003cstring\u003e","full_data_center":"\u003cstring\u003e","harddisk_id":"\u003cstring\u003e","id":"\u003cstring\u003e","internal_ip_addresses":["\u003cstring\u003e","\u003cstring\u003e"],"ip_address":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_reason":"Exceeded free webinar minutes limit.","leave_time":"\u003cdateTime\u003e","location":"\u003cstring\u003e","mac_addr":"\u003cstring\u003e","microphone":"\u003cstring\u003e","network_type":"PPP","participant_user_id":"\u003cstring\u003e","pc_name":"\u003cstring\u003e","recording":"\u003cboolean\u003e","registrant_id":"\u003cstring\u003e","role":"panelist","screen_share_quality":"bad","share_application":"\u003cboolean\u003e","share_desktop":"\u003cboolean\u003e","share_whiteboard":"\u003cboolean\u003e","sip_uri":"\u003cstring\u003e","speaker":"\u003cstring\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","version":"\u003cstring\u003e","video_quality":"poor","audio_call":[{"call_number":"\u003cstring\u003e","call_type":"call-in","zoom_number":"\u003cstring\u003e"},{"call_number":"\u003cstring\u003e","call_type":"call-out","zoom_number":"\u003cstring\u003e"}],"os":"\u003cstring\u003e","os_version":"\u003cstring\u003e","device_name":"\u003cstring\u003e"},{"audio_quality":"poor","connection_type":"\u003cstring\u003e","customer_key":"\u003cstring\u003e","data_center":"\u003cstring\u003e","device":"Android","domain":"\u003cstring\u003e","email":"\u003cstring\u003e","from_sip_uri":"\u003cstring\u003e","full_data_center":"\u003cstring\u003e","harddisk_id":"\u003cstring\u003e","id":"\u003cstring\u003e","internal_ip_addresses":["\u003cstring\u003e","\u003cstring\u003e"],"ip_address":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_reason":"Leave waiting room.","leave_time":"\u003cdateTime\u003e","location":"\u003cstring\u003e","mac_addr":"\u003cstring\u003e","microphone":"\u003cstring\u003e","network_type":"PPP","participant_user_id":"\u003cstring\u003e","pc_name":"\u003cstring\u003e","recording":"\u003cboolean\u003e","registrant_id":"\u003cstring\u003e","role":"attendee","screen_share_quality":"good","share_application":"\u003cboolean\u003e","share_desktop":"\u003cboolean\u003e","share_whiteboard":"\u003cboolean\u003e","sip_uri":"\u003cstring\u003e","speaker":"\u003cstring\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","version":"\u003cstring\u003e","video_quality":"good","audio_call":[{"call_number":"\u003cstring\u003e","call_type":"call-out","zoom_number":"\u003cstring\u003e"},{"call_number":"\u003cstring\u003e","call_type":"call-in","zoom_number":"\u003cstring\u003e"}],"os":"\u003cstring\u003e","os_version":"\u003cstring\u003e","device_name":"\u003cstring\u003e"}]}