Zoom\Api\ReportsApi

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

Method	HTTP request	Description
getBillingInvoicesReports()	GET /report/billing/invoices	Get billing invoice reports
getBillingReport()	GET /report/billing	Get billing reports
reportChatMessages()	GET /report/chat/sessions/{sessionId}	Get chat messages reports
reportChatSessions()	GET /report/chat/sessions	Get chat sessions reports
reportCloudRecording()	GET /report/cloud_recording	Get cloud recording usage report
reportDaily()	GET /report/daily	Get daily usage report
reportMeetingDetails()	GET /report/meetings/{meetingId}	Get meeting detail reports
reportMeetingParticipants()	GET /report/meetings/{meetingId}/participants	Get meeting participant reports
reportMeetingPolls()	GET /report/meetings/{meetingId}/polls	Get meeting poll reports
reportMeetings()	GET /report/users/{userId}/meetings	Get meeting reports
reportOperationLogs()	GET /report/operationlogs	Get operation logs report
reportSignInSignOutActivities()	GET /report/activities	Get sign In / sign out activity report
reportTelephone()	GET /report/telephone	Get telephone reports
reportUpcomingEvents()	GET /report/upcoming_events	Get upcoming events report
reportUsers()	GET /report/users	Get active/inactive host reports
reportWebinarDetails()	GET /report/webinars/{webinarId}	Get webinar detail reports
reportWebinarParticipants()	GET /report/webinars/{webinarId}/participants	Get webinar participant reports
reportWebinarPolls()	GET /report/webinars/{webinarId}/polls	Get webinar poll reports
reportWebinarQA()	GET /report/webinars/{webinarId}/qa	Get webinar Q&A report

`getBillingInvoicesReports()`

getBillingInvoicesReports($billing_id): \Zoom\Api\Model\GetBillingInvoicesReports200Response

Get billing invoice reports

Get department billing invoices reports for a specific billing period. Provide the billing_id of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from Get Billing Reports API. Prerequisites:
* Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature. Scopes: report:read:admin, report:master 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\ReportsApi(
    // 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
);
$billing_id = indfhgfhfho; // string | Unique Identifier of the Billing Report. Retrieve this ID from the response of **Get Billing Reports** API request.

try {
    $result = $apiInstance->getBillingInvoicesReports($billing_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getBillingInvoicesReports: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
billing_id	string	Unique Identifier of the Billing Report. Retrieve this ID from the response of Get Billing Reports API request.	[optional]

Name	Type	Description	Notes
session_id	string	Chat session 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.
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]
page_size	int	The number of records returned within a single API call.	[optional] [default to 30]
include_fields	string	Return all edited and deleted messages. The API only returns this value if the `include_fields` query parameter contains the `edited_messages` and/or the `deleted_messages` values. To include both edited and deleted messages, comma-separate both values.	[optional]
include_bot_message	bool	Whether to return the bot message. If false, the bot_message will not be returned in the response body.	[optional] [default to false]

Name	Type	Description	Notes
year	int	Year for this report	[optional]
month	int	Month for this report	[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.
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]
include_fields	string	Provide `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a meeting registrant.	[optional]

Name	Type	Description	Notes
user_id	GroupAdminsDeleteUserIdParameter	The user ID or email address of the user. For user-level apps, pass the `me` value.
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]
type	string	The meeting type to query for: * `past` — All past meetings. * `pastOne` — A single past user meeting. * `pastJoined` — All past meetings the account's users hosted or joined.	[optional] [default to 'past']

Name	Type	Description	Notes
from	\DateTime	Start date for which you would like to view the activity logs report. Using the `from` and `to` parameters, specify a monthly date range for the report as the API only provides one month worth of data in one request. The specified date range should fall within the last six months.	[optional]
to	\DateTime	End date up to which you would like to view the activity logs report.	[optional]
page_size	int	The number of records to be returned within a single API call	[optional]
next_page_token	string	Next page token is used to paginate through large result sets	[optional]

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.
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]
include_fields	string	The additional query parameters to include: * `registrant_id` — Include the registrant's ID in the API response. The registrant ID is the webinar participant's unique ID.	[optional]

Files

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

Zoom\Api\ReportsApi

getBillingInvoicesReports()

Example

Parameters

Return type

Authorization

HTTP request headers

getBillingReport()

Example

Parameters

Return type

Authorization

HTTP request headers

reportChatMessages()

Example

Parameters

Return type

Authorization

HTTP request headers

reportChatSessions()

Example

Parameters

Return type

Authorization

HTTP request headers

reportCloudRecording()

Example

Parameters

Return type

Authorization

HTTP request headers

reportDaily()

Example

Parameters

Return type

Authorization

HTTP request headers

reportMeetingDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

reportMeetingParticipants()

Example

Parameters

Return type

Authorization

HTTP request headers

reportMeetingPolls()

Example

Parameters

Return type

Authorization

HTTP request headers

reportMeetings()

Example

Parameters

Return type

Authorization

HTTP request headers

reportOperationLogs()

Example

Parameters

Return type

Authorization

HTTP request headers

reportSignInSignOutActivities()

Example

Parameters

Return type

Authorization

HTTP request headers

reportTelephone()

`getBillingInvoicesReports()`

`getBillingReport()`

`reportChatMessages()`

`reportChatSessions()`

`reportCloudRecording()`

`reportDaily()`

`reportMeetingDetails()`

`reportMeetingParticipants()`

`reportMeetingPolls()`

`reportMeetings()`

`reportOperationLogs()`

`reportSignInSignOutActivities()`

`reportTelephone()`

`reportUpcomingEvents()`

`reportUsers()`

`reportWebinarDetails()`

`reportWebinarParticipants()`

`reportWebinarPolls()`

`reportWebinarQA()`