Method: organizations.environments.optimizedStats.get

This api is similar to stats.get except that the response is less verbose. In the current scheme, a query parameter _optimized instructs Edge Analytics to change the response but since this behavior is not possible with protocol buffer and since this parameter is predominantly used by Edge UI, we are introducing a separate api.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The organization and environment 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

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

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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