Zoom Public API Documentation
Get Zoom Rooms details
GET {{baseUrl}}/metrics/zoomrooms/:zoomroomId?from=<date>&to=<date>&page_size=30&next_page_token=<string>
The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room. Prerequisites: Scopes: Rate Limit Label:
dashboard_zr:read:admin,dashboard:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) Start date in '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 worth of data at once. | |
to
|
string | (Required) End date. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"account_type": "<string>",
"calender_name": "<string>",
"camera": "<string>",
"device_ip": "<string>",
"email": "<string>",
"health": "<string>",
"id": "<string>",
"issues": [
"<string>",
"<string>"
],
"last_start_time": "<string>",
"location": "<string>",
"microphone": "<string>",
"room_name": "<string>",
"speaker": "<string>",
"status": "<string>",
"live_meeting": {
"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>",
"in_room_participants": "<integer>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>"
},
"past_meetings": {
"from": "<date>",
"to": "<date>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"meetings": [
{
"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>",
"in_room_participants": "<integer>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>"
},
{
"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>",
"in_room_participants": "<integer>",
"participants": "<integer>",
"start_time": "<dateTime>",
"topic": "<string>",
"user_type": "<string>",
"uuid": "<string>"
}
]
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/zoomrooms/:zoomroomId?from=<date>&to=<date>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS