List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.

Scopes

You will need authorization for the https://www.googleapis.com/auth/postmaster.readonly scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/postmaster.readonly. You can set the scope for this method like this: gmailpostmastertools1 --scope <scope> domains traffic-stats-list ...

Required Scalar Argument

  • <parent> (string)
    • The resource name of the domain whose traffic statistics we'd like to list. It should have the form domains/{domain_name}, where domain_name is the fully qualified domain name.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p end-date-day=integer

    • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

  • -p end-date-month=integer

    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • -p end-date-year=integer

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • -p page-size=integer

    • Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.

  • -p page-token=string

    • The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to ListTrafficStats method.

  • -p start-date-day=integer

    • Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

  • -p start-date-month=integer

    • Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • -p start-date-year=integer

    • Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").