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. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.

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. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organizationId}/environments/{environmentId/stats/{dimensions}` Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be 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. The resource name for which the interactive query will be executed. Must be of the form organizations/{organizationId}/environments/{environmentId/stats/{dimensions} Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be 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` The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
`timeUnit`	`string` A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
`timeRange`	`string` Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59
`filter`	`string` Enables drill-down on specific dimension values
`sort`	`string` This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
`sortby`	`string` Comma separated list of columns to sort the final result.
`aggTable`	`string` If customers want to query custom aggregate tables, then this parameter can be used to specify the table name. If this parameter is skipped, then Edge Query will try to retrieve the data from fact tables which will be expensive.
`limit`	`string` This parameter is used to limit the number of result items. Default and the max value is 14400.
`offset`	`string` 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` Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
`tsAscending`	`boolean` Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.
`realtime`	`boolean` Legacy field: not used anymore.
`sonar`	`boolean` This parameter routes the query to api monitoring service for last hour.
`tzo`	`string` This parameters contains the timezone offset value.
`accuracy`	`string` Legacy field: not used anymore. This field is present to support UI calls which still use this parameter.

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