Method: organizations.environments.stats.get

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
Try it!

Retrieve metrics grouped by dimensions. 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.

HTTP request

GET https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/stats/**}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings, such as `apiproxy` or `target_host`. The value of dimensions should be a comma-separated list, as shown below: `organizations/{org}/environments/{env}/stats/apiproxy,request_verb` Authorization requires the following IAM permission on the specified resource `name`: `apigee.environments.getStats`

name

string

Required. Resource name for which the interactive query will be executed. Use the following format in your request: organizations/{org}/environments/{env}/stats/{dimensions}

Dimensions let you view metrics in meaningful groupings, such as apiproxy or target_host. The value of dimensions should be a comma-separated list, as shown below: organizations/{org}/environments/{env}/stats/apiproxy,request_verb

Authorization requires the following IAM permission on the specified resource name:

apigee.environments.getStats

Query parameters

Parameters
`select`	`string` Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
`timeUnit`	`string` Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or`month`.
`timeRange`	`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`
`filter`	`string` Filter that enables you to drill down on specific dimension values.
`sort`	`string` Flag that specifies whether the sort order should be ascending or descending. Valid values include: `DESC` and `ASC`.
`sortby`	`string` Comma-separated list of columns to sort the final result.
`aggTable`	`string` Table name used to query custom aggregate tables. If this parameter is skipped, then Apigee will try to retrieve the data from fact tables which will be expensive.
`limit`	`string` Maximum number of result items to return. The default and maximum value that can be returned is 14400.
`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`.
`topk`	`string` Top number of results to return. For example, to return the top 5 results, set `topk=5`.
`tsAscending`	`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`.
`realtime`	`boolean` No longer used by Apigee. Supported for backwards compatibility.
`sonar`	`boolean` Routes the query to API Monitoring for the last hour.
`tzo`	`string` Timezone offset value.
`accuracy`	`string` No longer used by Apigee. Supported for backwards compatibility.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Stats.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform