Method: customerUsageReports.get

Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.

HTTP request

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/{date}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
date

string

Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.

Query parameters

Parameters
customerId

string

The unique ID of the customer to retrieve data for.

pageToken

string

Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.

parameters

string

The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites.
A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of UsageReports.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

For more information, see the OAuth 2.0 Overview.