Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Account Events
App Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Recording Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
get

/metrics/meetings/{meetingId}

Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy
Prerequisites:

  • Business or a higher plan.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Responses

HTTP Status Code: 200
Meeting returned.
Only available for paid accounts that have enabled the dashboard feature.

1 Example
Schema
object

Meeting metric details.

uuid
string

Meeting UUID. Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains ‘//’ in it.

1 validation
id
integer

Meeting ID: Unique identifier of the meeting in “long” format(represented as int64 data type in JSON), also known as the meeting number.

1 validation
topic
string

Meeting topic.

host
string

Host display name.

email
string

Email address of the host.

user_type
string

License type of the user.

start_time
string

Meeting start time.

1 validation
end_time
string

Meeting end time.

1 validation
duration
string

Meeting duration.

participants
integer

Meeting participant count.

has_pstn
boolean

Indicates whether or not the PSTN was used in the meeting.

has_voip
boolean

Indicates whether or not VoIP was used in the meeting.

has_3rd_party_audio
boolean

Indicates whether or not third party audio was used in the meeting.

has_video
boolean

Indicates whether or not video was used in the meeting.

has_screen_share
boolean

Indicates whether or not screenshare feature was used in the meeting.

has_recording
boolean

Indicates whether or not the recording feature was used in the meeting.

has_sip
boolean

Indicates whether or not someone joined the meeting using SIP.

in_room_participants
integer

The number of Zoom Room participants in the meeting.

dept
string

Department of the host.

Send a Test Request

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