You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">This api is similar to GetStats 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.</p>
82
+
<pclass="firstline">Similar to GetStats except that the response is less verbose.</p>
<pre>This api is similar to GetStats 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.
91
+
<pre>Similar to GetStats except that the response is less verbose.
92
92
93
93
Args:
94
-
name: string, Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/environments/{environment_id/optimizedStats/{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}/optimizedStats/apiproxy,request_verb` (required)
95
-
accuracy: string, Legacy field: not used anymore.
96
-
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.
97
-
filter: string, Enables drill-down on specific dimension values.
98
-
limit: string, This parameter is used to limit the number of result items. Default and the max value is 14400.
99
-
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'.
100
-
realtime: boolean, Legacy field: not used anymore.
101
-
select: string, Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)
102
-
sonar: boolean, This parameter routes the query to api monitoring service for last hour.
103
-
sort: string, This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.
104
-
sortby: string, Commaseparated list of columns to sort the final result.
105
-
timeRange: string, Required. 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
106
-
timeUnit: string, A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.
107
-
topk: string, Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.
108
-
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.
109
-
tzo: string, This parameters contains the timezone offset value.
94
+
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)
95
+
accuracy: string, No longer used by Apigee. Supported for backwards compatibility.
96
+
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.
97
+
filter: string, Filter that enables you to drill-down on specific dimension values.
98
+
limit: string, Maximum number of result items to return. The default and maximum value that can be returned is 14400.
99
+
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`.
100
+
realtime: boolean, No longer used by Apigee. Supported for backwards compatibility.
101
+
select: string, Required. Comma-separated list of metrics. For example: `sum(message_count),sum(error_count)`
102
+
sonar: boolean, Routes the query to API Monitoring for the last hour.
103
+
sort: string, Flag that specifies whether the sort order should be ascending or descending. Valid values include `DESC` and `ASC`.
104
+
sortby: string, Comma-separated list of columns to sort the final result.
105
+
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`
106
+
timeUnit: string, Granularity of metrics returned. Valid values include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
107
+
topk: string, Top number of results to return. For example, to return the top 5 results, set `topk=5`.
108
+
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`.
109
+
tzo: string, Timezone offset value.
110
110
x__xgafv: string, V1 error format.
111
111
Allowed values
112
112
1 - v1 error format
@@ -116,20 +116,20 @@ <h3>Method Details</h3>
116
116
An object of the form:
117
117
118
118
{
119
-
"Response": { # This message type encapsulates a response format for Js Optimized Scenario. # This field wraps the stats response for Js Optimized Scenario with a Response key. E.g. { "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 ] } ] } ] } } }
120
-
"TimeUnit": [ # This field contains a list of time unit values. Time unit refers to an epoch timestamp value.
"TimeUnit": [ # List of time unit values. Time unit refers to an epoch timestamp value.
121
121
"A String",
122
122
],
123
-
"metaData": { # This message type encapsulates additional information about query execution. # This field contains metadata information about the query executed
123
+
"metaData": { # Encapsulates additional information about query execution. # Metadata information about the query executed.
124
124
"errors": [ # List of error messages as strings.
125
125
"A String",
126
126
],
127
-
"notices": [ # List of additional information such as data source, if result was truncated etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api.uapgroup2.agg_api" ]
127
+
"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" ]```
128
128
"A String",
129
129
],
130
130
},
131
-
"resultTruncated": True or False, # This ia a boolean field to indicate if the results were truncated based on the limit parameter.
132
-
"stats": { # This message type 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. # This field contains a stats results.
131
+
"resultTruncated": True or False, # Boolean flag that indicates whether the results were truncated based on the limit parameter.
132
+
"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.
0 commit comments