Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. You can optionally pass dimensions as path parameters to the stats API. If dimensions are not specified, the metrics are computed on the entire set of data for the given time range.


You will need authorization for the scope to make a valid call.

If unset, the scope for this method defaults to You can set the scope for this method like this: apigee1 --scope <scope> organizations host-stats-get ...

Required Scalar Argument

  • <name> (string)
    • Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/{org}/hostStats/{dimensions} Dimensions let you view metrics in meaningful groupings, such as apiproxy, target_host. The value of dimensions should be a comma-separated list as shown below organizations/{org}/hostStats/apiproxy,request_verb

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 accuracy=string

    • No longer used by Apigee. Supported for backwards compatibility.
  • -p envgroup-hostname=string

    • Required. Hostname for which the interactive query will be executed.
  • -p filter=string

    • Flag that enables drill-down on specific dimension values.
  • -p limit=string

    • Maximum number of result items to return. The default and maximum value that can be returned is 14400.
  • -p offset=string

    • Offset value. Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to 10 and offset to 10.
  • -p realtime=boolean

    • No longer used by Apigee. Supported for backwards compatibility.
  • -p select=string

    • Comma-separated list of metrics. For example: sum(message_count),sum(error_count)
  • -p sort=string

    • Flag that specifies if the sort order should be ascending or descending. Valid values are DESC and ASC.
  • -p sortby=string

    • Comma-separated list of columns to sort the final result.
  • -p time-range=string

    • Time interval for the interactive query. Time range is specified in GMT as start~end. For example: 04/15/2017 00:00~05/15/2017 23:59
  • -p time-unit=string

    • Granularity of metrics returned. Valid values include: second, minute, hour, day, week, or month.
  • -p topk=string

    • Top number of results to return. For example, to return the top 5 results, set topk=5.
  • -p ts-ascending=boolean

    • Flag that specifies whether to list timestamps in ascending (true) or descending (false) order. Apigee recommends that you set this value to true if you are using sortby with sort=DESC.
  • -p tzo=string

    • Timezone offset value.

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