Get webinar sharing/recording details
GET {{baseUrl}}/metrics/webinars/:webinarId/participants/sharing?type=live&page_size=30&next_page_token=<string>
Retrieve the sharing and recording details of participants from live or past webinars.
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
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 | | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceed the current page size. This token's expiration period is 15 minutes. |
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":[{"details":[{"content":"\u003cstring\u003e","end_time":"\u003cstring\u003e","start_time":"\u003cstring\u003e"},{"content":"\u003cstring\u003e","end_time":"\u003cstring\u003e","start_time":"\u003cstring\u003e"}],"id":"\u003cstring\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e"},{"details":[{"content":"\u003cstring\u003e","end_time":"\u003cstring\u003e","start_time":"\u003cstring\u003e"},{"content":"\u003cstring\u003e","end_time":"\u003cstring\u003e","start_time":"\u003cstring\u003e"}],"id":"\u003cstring\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e"}]}