Zoom\Api\DashboardsApi

All URIs are relative to https://api.zoom.us/v2.

Method	HTTP request	Description
dashboardCRC()	GET /metrics/crc	Get CRC port usage
dashboardChat()	GET /metrics/chat	Get chat metrics
dashboardClientFeedback()	GET /metrics/client/feedback	List Zoom meetings client feedback
dashboardClientFeedbackDetail()	GET /metrics/client/feedback/{feedbackId}	Get zoom meetings client feedback
dashboardIM()	GET /metrics/im	Get IM metrics
dashboardIssueDetailZoomRoom()	GET /metrics/issues/zoomrooms/{zoomroomId}	Get issues of Zoom Rooms
dashboardIssueZoomRoom()	GET /metrics/issues/zoomrooms	Get top 25 Zoom Rooms with issues
dashboardMeetingDetail()	GET /metrics/meetings/{meetingId}	Get meeting details
dashboardMeetingParticipantQOS()	GET /metrics/meetings/{meetingId}/participants/{participantId}/qos	Get meeting participant QoS
dashboardMeetingParticipantShare()	GET /metrics/meetings/{meetingId}/participants/sharing	Get sharing/recording details
dashboardMeetingParticipants()	GET /metrics/meetings/{meetingId}/participants	List meeting participants
dashboardMeetingParticipantsQOS()	GET /metrics/meetings/{meetingId}/participants/qos	List meeting participants QoS
dashboardMeetingParticipantsQOSSummary()	GET /metrics/meetings/{meetingId}/participants/qos_summary	List meeting participants QoS Summary
dashboardMeetings()	GET /metrics/meetings	List meetings
dashboardQuality()	GET /metrics/quality	Get meeting quality scores
dashboardWebinarDetail()	GET /metrics/webinars/{webinarId}	Get webinar details
dashboardWebinarParticipantQOS()	GET /metrics/webinars/{webinarId}/participants/{participantId}/qos	Get webinar participant QoS
dashboardWebinarParticipantShare()	GET /metrics/webinars/{webinarId}/participants/sharing	Get sharing/recording details
dashboardWebinarParticipants()	GET /metrics/webinars/{webinarId}/participants	Get webinar participants
dashboardWebinarParticipantsQOS()	GET /metrics/webinars/{webinarId}/participants/qos	List webinar participant QoS
dashboardWebinarParticipantsQOSSummary()	GET /metrics/webinars/{webinarId}/participants/qos_summary	List webinar participants QoS Summary
dashboardWebinars()	GET /metrics/webinars	List webinars
dashboardZoomRoom()	GET /metrics/zoomrooms/{zoomroomId}	Get Zoom Rooms details
dashboardZoomRoomIssue()	GET /metrics/zoomrooms/issues	Get top 25 issues of Zoom Rooms
dashboardZoomRooms()	GET /metrics/zoomrooms	List Zoom Rooms
getClientVersions()	GET /metrics/client_versions	List the client versions
listMeetingSatisfaction()	GET /metrics/client/satisfaction	List client meeting satisfaction
participantFeedback()	GET /metrics/meetings/{meetingId}/participants/satisfaction	Get post meeting feedback
participantWebinarFeedback()	GET /metrics/webinars/{webinarId}/participants/satisfaction	Get post webinar feedback

`dashboardCRC()`

dashboardCRC($from, $to): \Zoom\Api\Model\DashboardCRC200Response

Get CRC port usage

A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time.

We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".

Prerequisites:
* Business, Education or API Plan. * Room Connector must be enabled on the account.

Scopes: dashboard_crc:read:admin
Rate Limit Label: Heavy

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\DashboardsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$from = Fri Dec 31 19:00:00 EST 2021; // \DateTime | 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 = Thu Jan 27 19:00:00 EST 2022; // \DateTime | End date.

try {
    $result = $apiInstance->dashboardCRC($from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->dashboardCRC: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
from	\DateTime	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	\DateTime	End date.

Name	Type	Description	Notes
feedback_id	string	Feedback Detail Id
from	\DateTime		[optional]
to	\DateTime		[optional]
page_size	int		[optional] [default to 30]
next_page_token	string		[optional]

Name	Type	Description	Notes
zoomroom_id	string	The Zoom room ID.
from	\DateTime	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	\DateTime	End date.
page_size	int	The number of records returned within a single API call.	[optional] [default to 30]
next_page_token	string	The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.	[optional]

Name	Type	Description	Notes
meeting_id	ListPastMeetingPollsMeetingIdParameter	The meeting's ID or universally unique ID (UUID). * If you provide a meeting ID, the API will return a response for the latest meeting instance. * If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you must double-encode the meeting UUID before making an API request.
type	string	The type of meeting to query: * `past` — All past meetings. * `pastOne` — All past one-user meetings. * `live` - All live meetings. This value defaults to `live`.	[optional] [default to 'live']

Name	Type	Description	Notes
webinar_id	string	The webinar's ID or universally unique ID (UUID). * If you provide a webinar ID, the API will return a response for the latest webinar instance. * If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you must double-encode the webinar UUID before making an API request.
type	string	The type of webinar to query: * `past` — All past webinars. * `live` - All live webinars. This value defaults to `live`.	[optional] [default to 'live']

Name	Type	Description	Notes
from	\DateTime	The start date for the query in “yyyy-mm-dd” format.	[optional]
to	\DateTime	The end date for the query in “yyyy-mm-dd” format.	[optional]

Files

DashboardsApi.md

Latest commit

History

DashboardsApi.md

File metadata and controls

Zoom\Api\DashboardsApi

dashboardCRC()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardChat()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardClientFeedback()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardClientFeedbackDetail()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardIM()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardIssueDetailZoomRoom()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardIssueZoomRoom()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingDetail()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingParticipantQOS()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingParticipantShare()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingParticipants()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingParticipantsQOS()

Example

Parameters

Return type

Authorization

HTTP request headers

dashboardMeetingParticipantsQOSSummary()

`dashboardCRC()`

`dashboardChat()`

`dashboardClientFeedback()`

`dashboardClientFeedbackDetail()`

`dashboardIM()`

`dashboardIssueDetailZoomRoom()`

`dashboardIssueZoomRoom()`

`dashboardMeetingDetail()`

`dashboardMeetingParticipantQOS()`

`dashboardMeetingParticipantShare()`

`dashboardMeetingParticipants()`

`dashboardMeetingParticipantsQOS()`

`dashboardMeetingParticipantsQOSSummary()`

`dashboardMeetings()`

`dashboardQuality()`

`dashboardWebinarDetail()`

`dashboardWebinarParticipantQOS()`

`dashboardWebinarParticipantShare()`

`dashboardWebinarParticipants()`

`dashboardWebinarParticipantsQOS()`

`dashboardWebinarParticipantsQOSSummary()`

`dashboardWebinars()`

`dashboardZoomRoom()`