- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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 https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
userKey or all |
Represents the profile ID or the user email for which the data should be filtered. Can be |
date |
Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the ISO 8601 format, |
Query parameters
Parameters | |
---|---|
customerId |
The unique ID of the customer to retrieve data for. |
filters |
The Filters are in the form In this example, the 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%3C%3E2010-10-28T10:26:35.000Z The relational operators include:
|
maxResults |
Determines how many activity records are shown on each response page. For example, if the request sets |
orgUnitID |
ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. |
pageToken |
Token to specify next page. A report with multiple pages has a |
parameters |
The |
groupIdFilter |
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:
https://www.googleapis.com/auth/admin.reports.usage.readonly
For more information, see the Authorization guide.