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. Try it now.

Request

HTTP request

GET https://www.googleapis.com/admin/reports/v1/usage/users/userKey or all/dates/date

Parameters

Parameter name Value Description
Path 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.
userKey or all string Represents the profile ID or the user email for which the data should be filtered.

Acceptable values are:
  • "all": Returns all administrator information.
  • "userKey": Represents the user's unique G Suite profile ID or the primary email address of the person or entity making the change to the application, or causes a change to happen.
Optional query parameters
customerId string The unique ID of the customer to retrieve data for.
filters string 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):

GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time>2010-10-28T10:26:35.000Z 

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=).

maxResults unsigned integer 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. Acceptable values are 1 to 1000, inclusive. (Default: 1000)
orgUnitID string ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit.
pageToken string 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.
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.

Authorization

This request requires authorization with the following scope:

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 UserUsageReport resource in the response body.

Try it!

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