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:
- Business, Education or API Plan with Zoom Rooms set up.
Scopes:
dashboard_zr:read:admin
,
dashboard:read:admin
Rate Limit Label
:
Heavy
Request Params
| 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":"\u003cstring\u003e","calender_name":"\u003cstring\u003e","camera":"\u003cstring\u003e","device_ip":"\u003cstring\u003e","email":"\u003cstring\u003e","health":"\u003cstring\u003e","id":"\u003cstring\u003e","issues":["\u003cstring\u003e","\u003cstring\u003e"],"last_start_time":"\u003cstring\u003e","location":"\u003cstring\u003e","microphone":"\u003cstring\u003e","room_name":"\u003cstring\u003e","speaker":"\u003cstring\u003e","status":"\u003cstring\u003e","live_meeting":{"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","in_room_participants":"\u003cinteger\u003e","participants":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","user_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"past_meetings":{"from":"\u003cdate\u003e","to":"\u003cdate\u003e","next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_size":30,"total_records":"\u003cinteger\u003e","meetings":[{"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","in_room_participants":"\u003cinteger\u003e","participants":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","user_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},{"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","in_room_participants":"\u003cinteger\u003e","participants":"\u003cinteger\u003e","start_time":"\u003cdateTime\u003e","topic":"\u003cstring\u003e","user_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e"}]}}