get

Retrieves a report which is a collection of properties and statistics for a specific customer’s account. For more information, see the Customers Usage Report guide. For more information about the customer report’s parameters, see the Customers Usage parameters reference guides.

Synopsis

Implements the API documented at https://developers.google.com/admin-sdk/reports/reference/rest/v1/customerUsageReports/get

gsm customerUsageReports 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.
  -h, --help                help for get
      --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.
                            
                            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.

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 customerUsageReports - Manage (get) Customer Usage Reports (Part of Admin SDK)