Close httplib2 connections.
Similar to GetStats except that the response is less verbose.
close()
Close httplib2 connections.
get(name, accuracy=None, aggTable=None, filter=None, limit=None, offset=None, realtime=None, select=None, sonar=None, sort=None, sortby=None, timeRange=None, timeUnit=None, topk=None, tsAscending=None, tzo=None, x__xgafv=None)
Similar to GetStats except that the response is less verbose.
Args:
name: string, Required. Resource name for which the interactive query will be executed. Use the following format in your request: `organizations/{org}/environments/{env}/optimizedStats/{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}/environments/{env}/optimizedStats/apiproxy,request_verb` (required)
accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
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.
filter: string, Filter that enables you to drill-down on specific dimension values.
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`.
realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
select: string, Required. Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
sonar: boolean, Routes the query to API Monitoring for the last hour.
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.
timeRange: string, Required. 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`
timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
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 setting this value to `true` if you are using `sortby` with `sort=DESC`.
tzo: string, Timezone offset value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"Response": { # Encapsulates a response format for JavaScript Optimized Scenario. # Wraps the `stats` response for JavaScript Optimized Scenario with a response key. For example: ```{ "Response": { "TimeUnit": [], "metaData": { "errors": [], "notices": [ "Source:Postgres", "Table used: edge.api.aaxgroup001.agg_api", "PG Host:ruappg08-ro.production.apigeeks.net", "query served by:80c4ebca-6a10-4a2e-8faf-c60c1ee306ca" ] }, "resultTruncated": false, "stats": { "data": [ { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }, { "env": "prod", "name": "sum(is_error)", "values": [ 36.0 ] } ] } ] } } }```
"TimeUnit": [ # List of time unit values. Time unit refers to an epoch timestamp value.
"A String",
],
"metaData": { # Encapsulates additional information about query execution. # Metadata information about the query executed.
"errors": [ # List of error messages as strings.
"A String",
],
"notices": [ # List of additional information such as data source, if result was truncated. For example: ``` "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]```
"A String",
],
},
"resultTruncated": True or False, # Boolean flag that indicates whether the results were truncated based on the limit parameter.
"stats": { # Encapsulates a data node as represented below: ``` { "identifier": { "names": [ "apiproxy" ], "values": [ "sirjee" ] }, "metric": [ { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] } ] }``` or ``` { "env": "prod", "name": "sum(message_count)", "values": [ 36.0 ] }``` Depending on whether a dimension is present in the query or not the data node type can be a simple metric value or dimension identifier with list of metrics. # `stats` results.
"data": [
"",
],
},
},
}