CustomerUsageReports: get

Requires authorization

Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Developer's Guide.

Try it now.

Request

HTTP request

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

Parameters

Parameter name	Value	Description
Required 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.
Optional parameters
`customerId`	`string`	The unique ID of the customer to retrieve data for.
`pageToken`	`string`	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`. Note: The API does not accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "reports#usageReports",
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "nextPageToken": string,
  "usageReports": [
    {
      "kind": "usageReport",
      "date": string,
      "entity": {
        "type": string,
        "customerId": string
      },
      "parameters": [
        {
          "name": string,
          "stringValue": string,
          "datetimeValue": datetime,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}

Property name	Value	Description
`kind`	`string`	The type of API resource. For a usage report, the value is `reports#usageReports`.
`warnings[]`	`list`	Warnings if any.
`warnings[].code`	`string`	Machine readable code or warning type. The warning code value is `200`.
`warnings[].message`	`string`	The human readable messages for a warning are: Data is not available warning – Sorry, data for date yyyy-mm-dd for application application name is not available. Partial data is available warning – Data for date yyyy-mm-dd for application application name is not available right now, please try again after a few hours.
`warnings[].data[]`	`list`	Key-value pairs to give detailed information on the warning.
`warnings[].data[].key`	`string`	Key associated with a key-value pair to give detailed information on the warning.
`warnings[].data[].value`	`string`	Value associated with a key-value pair to give detailed information on the warning.
`nextPageToken`	`string`	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.
`usageReports[]`	`list`	Various application parameter records.
`usageReports[].kind`	`string`	The type of API resource. For a usage report, the value is `usageReport`.
`usageReports[].date`	`string`	The date of the report request.
`usageReports[].entity`	`object`	Information about the type of the item.
`usageReports[].entity.type`	`string`	The type of item. The value is `customer`.
`usageReports[].entity.customerId`	`string`	The unique identifier of the customer's account.
`usageReports[].parameters[]`	`list`	Parameter value pairs for various applications. For the Customers usage report parameters and values, see the customer usage parameters reference.
`usageReports[].parameters[].name`	`string`	The name of the parameter. For the Customers usage report parameter names, see the customer usage parameters reference.
`usageReports[].parameters[].stringValue`	`string`	String value of the parameter.
`usageReports[].parameters[].datetimeValue`	`datetime`	The RFC 3339 formatted value of the parameter, for example `2010-10-28T10:26:35.000Z`.
`usageReports[].parameters[].intValue`	`long`	Integer value of the parameter.
`usageReports[].parameters[].boolValue`	`boolean`	Boolean value of the parameter.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.