Get webinar participant reports
GET {{baseUrl}}/report/webinars/:webinarId/participants?page_size=30&next_page_token=<string>&include_fields=registrant_id
Get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months.
Prerequisites: * A Pro or a higher plan with Webinar add-on enabled.
Scopes: report:read:admin
Rate Limit Label: Heavy
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page_size | number | The number of records returned within a single API call. | |
next_page_token | string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
include_fields | string | The additional query parameters to include. |
registrant_id
- Include the registrant's ID in the API response. The registrant ID is the webinar participant'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":[{"customer_key":"\u003cstring\u003e","duration":"\u003cinteger\u003e","failover":"\u003cboolean\u003e","id":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_time":"\u003cdateTime\u003e","name":"\u003cstring\u003e","registrant_id":"\u003cstring\u003e","status":"in_waiting_room","user_email":"pa2SVS.sWdoVD.Z$.QP%b.E/krc/p}yl@aGBRv.rta","user_id":"\u003cstring\u003e","participant_user_id":"\u003cstring\u003e"},{"customer_key":"\u003cstring\u003e","duration":"\u003cinteger\u003e","failover":"\u003cboolean\u003e","id":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_time":"\u003cdateTime\u003e","name":"\u003cstring\u003e","registrant_id":"\u003cstring\u003e","status":"in_waiting_room","user_email":"JA87FIm.iMR|i.CVTsc{i.G}Fa`.^@RSAgC6ozL.4.-HOafM.3cFNJWUcPJR.xYgpOpmpzcx.fZ3.Qtsl1nuuUn.FA61y.Ql","user_id":"\u003cstring\u003e","participant_user_id":"\u003cstring\u003e"}]}