Method: userUsageReport.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.

HTTP request

GET{userKey or all}/dates/{date}

The URL uses gRPC Transcoding syntax.

Path parameters

userKey or all


Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call users.list in Directory API with showDeleted=true, then use the returned ID as the userKey.



Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, yyyy-mm-dd.

Query parameters



The unique ID of the customer to retrieve data for.



The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, docs, and gmail.

Filters are in the form [application name]:[parameter name][relational operator][parameter value],....

In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E):


The relational operators include:

  • == - 'equal to'.
  • <> - 'not equal to'. It is URL-encoded (%3C%3E).
  • < - 'less than'. It is URL-encoded (%3C).
  • <= - 'less than or equal to'. It is URL-encoded (%3C=).
  • > - 'greater than'. It is URL-encoded (%3E).
  • >= - 'greater than or equal to'. It is URL-encoded (%3E=).


integer (uint32 format)

Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page.
The maxResults query string is optional.



ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit.



Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query 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.



Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"

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:


For more information, see the Authorization guide.