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.
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/reports/reference/rest/v1/userUsageReport/get
gsm userUsageReports get [flags]
Options
--customerId string The unique ID of the customer to retrieve data for.
--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. (default "2023-10-30")
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
--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 Entities 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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0
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=).
Filters can only be applied to numeric parameters.
--groupIdFilter string 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"
-h, --help help for get
--orgUnitId string ID of the organizational unit to report on.
Activity records will be shown only for users who belong to the specified organizational unit.
Data before Dec 17, 2018 doesn't appear in the filtered results.
--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 Entities usage report are only gplus.
A parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2]....
Note: The API doesn't 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.
--userKey string 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 Workspace profile ID or their primary email address. (default "all")
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm userUsageReports - Manage (get) User Usage Reports (Part of Admin SDK)