Skip to content

Generate an admin report

GET /ringcentral/admin/report

Generates an account-level RingCentral calls and messages report using OAuth credentials previously stored for the RingCentral account associated with userJwt. The route authenticates an App Connect CRM user but does not independently verify that the caller is currently a RingCentral administrator.

Operation ID: getRingCentralAdminReport
Authorization: BEARER or API key

Parameters

Name Location Type Required Description
timezone query string No IANA timezone used to group report data.
timeFrom query string · date-time No Inclusive report start time.
timeTo query string · date-time No Exclusive report end time.
groupBy query string No Report aggregation interval.

Responses

Status Description Body
200 Successful route-specific JSON response. Consult the operation description for ownership and semantics. GenericSuccessResponse
400 Bad request, missing authentication, or connector error. ErrorResponse, string