UserUsageReport

The User Usage Report returns G Suite service activities across your account's users. For more information, see the User Usage Report guide.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "kind": "admin#reports#usageReports",
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "nextPageToken": string,
  "usageReports": [
    {
      "kind": "admin#reports#usageReport",
      "date": string,
      "entity": {
        "type": string,
        "customerId": string,
        "userEmail": string,
        "profileId": long
      },
      "parameters": [
        {
          "name": string,
          "stringValue": string,
          "datetimeValue": datetime,
          "intValue": long,
          "boolValue": boolean
        }
      ]
    }
  ]
}
Property name Value Description Notes
kind string The type of API resource. For a usage report, the value is admin#reports#usageReports.
warnings[] list Warnings, if any.
warnings[].code string Machine readable code or warning type. The warning code value is 200.

Acceptable values are:
  • "DATA_NOT_AVAILABLE"
  • "PARTIAL_DATA_AVAILABLE"
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 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.
usageReports[] list Various application parameter records.
usageReports[].kind string The type of API resource. For a usage report, the value is admin#reports#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[].entity.userEmail string The user's email address.
usageReports[].entity.profileId long The user's immutable G Suite profile identifier.
usageReports[].entity.entityId string The object key, which is Users.
usageReports[].parameters[] list Parameter value pairs for various applications. For the User Usage Report parameters and values, see the User Usage parameters reference.
usageReports[].parameters[].name string The name of the parameter. For the User Usage Report parameter names, see the User 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.

Methods

get
Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.