List webinars
GET {{baseUrl}}/metrics/webinars?type=live&from=<date>&to=<date>&page_size=30&next_page_token=<string>&group_id=<string>
Lists all the live or past webinars from a specified period of time.
Prerequisites
- Business, Education or API Plan with Webinar add-on.
Scopes:
dashboard_webinars:read:admin
,
dashboard:read:admin
Rate Limit Label
:
RESOURCE-INTENSIVE
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. |
| from | string | | (Required) The start date in 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'format. The date range defined by the from and to parameters should only be one month, as the report includes only one month's worth of data at once. |
| to | string | | (Required) The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format. |
| 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. |
| group_id | string | | The group ID. To get a group ID, use the List groups API.
Note: The API response will only contain meetings where the host is a member of the queried group ID. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"from":"\u003cdate\u003e","to":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":30,"total_records":"\u003cinteger\u003e","webinars":[{"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":"good","screen_share_quality":"bad"},{"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":"good","video_quality":"good","screen_share_quality":"bad"}]}