GET {{baseUrl}}/metrics/webinars/:webinarId?type=live
Retrieve details from live or past webinars. Prerequisites: Scopes: Rate Limit Label:
dashboard_webinars:read:admin
,dashboard:read:admin
Heavy
Body
PARAM
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": "<string>",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"dept": "<string>",
"duration": "<string>",
"email": "<string>",
"end_time": "<dateTime>",
"has_3rd_party_audio": "<boolean>",
"has_archiving": "<boolean>",
"has_pstn": "<boolean>",
"has_recording": "<boolean>",
"has_screen_share": "<boolean>",
"has_sip": "<boolean>",
"has_video": "<boolean>",
"has_voip": "<boolean>",
"has_manual_captions": "<boolean>",
"has_automated_captions": "<boolean>",
"id": "<long>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>",
"audio_quality": "poor",
"video_quality": "fair",
"screen_share_quality": "fair"
} |
ENDPOINTS