Get webinar details
GET {{baseUrl}}/metrics/webinars/:webinarId?type=live
Retrieve details 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. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"host":"\u003cstring\u003e","custom_keys":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"dept":"\u003cstring\u003e","duration":"\u003cstring\u003e","email":"\u003cstring\u003e","end_time":"\u003cdateTime\u003e","has_3rd_party_audio":"\u003cboolean\u003e","has_archiving":"\u003cboolean\u003e","has_pstn":"\u003cboolean\u003e","has_recording":"\u003cboolean\u003e","has_screen_share":"\u003cboolean\u003e","has_sip":"\u003cboolean\u003e","has_video":"\u003cboolean\u003e","has_voip":"\u003cboolean\u003e","has_manual_captions":"\u003cboolean\u003e","has_automated_captions":"\u003cboolean\u003e","id":"\u003clong\u003e","participants":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","user_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e","audio_quality":"poor","video_quality":"fair","screen_share_quality":"fair"}