Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/webinars/{webinarId}

Retrieve details from live or past webinars.

Scopes: dashboard_webinars:read:admin
Rate Limit Label: Heavy
Prerequisites:

  • Business, Education or API Plan with Webinar add-on.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Responses

HTTP Status Code: 200
Webinar details returned.
Only available for paid accounts that have enabled the Dashboard feature.

1 Example
Schema
object

Webinar metric details.

uuid
string

Webinar UUID.

id
integer

Webinar ID in “long” format(represented as int64 data type in JSON), also known as the webinar number.

1 validation
topic
string

Webinar topic.

host
string

User display name.

email
string

User email.

user_type
string

User type.

start_time
string

Webinar start time.

1 validation
end_time
string

Webinar end time.

1 validation
duration
string

Webinar duration, formatted as hh:mm:ss, for example: 10:00 for ten minutes.

participants
integer

Webinar participant count.

has_pstn
boolean

Indicates whether or not PSTN was used for the Webinar.

has_voip
boolean

Indicates whether or not VoIP was used for the Webinar.

has_3rd_party_audio
boolean

Indicates whether or not TSP was used for the Webinar.

has_video
boolean

Indicates whether or not video was used for the Webinar.

has_screen_share
boolean

Indicates whether or not screen sharing was used for the Webinar.

has_recording
boolean

Indicates whether or not recording was used for the Webinar.

has_sip
boolean

Indicates whether or not SIP was used for the Webinar.

has_archiving
boolean

Whether the archiving feature was used in the webinar.

dept
string

Department of the host.

custom_keys
array[object]

Custom keys and values assigned to the Webinar.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
webinarId
$$.env
1 variable not set
oauth_access_token