| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.optimizedStats.html">optimizedStats</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, timeRange=None, offset=None, accuracy=None, timeUnit=None, limit=None, filter=None, topk=None, sonar=None, sortby=None, tzo=None, realtime=None, sort=None, select=None, aggTable=None, tsAscending=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">This api is similar to GetStats</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(name, timeRange=None, offset=None, accuracy=None, timeUnit=None, limit=None, filter=None, topk=None, sonar=None, sortby=None, tzo=None, realtime=None, sort=None, select=None, aggTable=None, tsAscending=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| 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/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` (required) |
| 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 |
| 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'. |
| accuracy: string, Legacy field: not used anymore. |
| timeUnit: string, A value of second, minute, hour, day, week, month. |
| Time Unit specifies the granularity of metrics returned. |
| limit: string, This parameter is used to limit the number of result items. |
| Default and the max value is 14400. |
| filter: string, Enables drill-down on specific dimension values. |
| topk: string, Take 'top k' results from results, for example, to return the top 5 |
| results 'topk=5'. |
| sonar: boolean, This parameter routes the query to api monitoring service for last hour. |
| sortby: string, Comma separated list of columns to sort the final result. |
| tzo: string, This parameters contains the timezone offset value. |
| realtime: boolean, Legacy field: not used anymore. |
| sort: string, This parameter specifies if the sort order should be ascending or |
| descending Supported values are DESC and ASC. |
| select: string, Required. The select parameter contains a comma separated list of metrics. |
| E.g. sum(message_count),sum(error_count) |
| 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. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "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 |
| # ] |
| # } |
| # ] |
| # } |
| # ] |
| # } |
| # } |
| # } |
| "resultTruncated": True or False, # This ia a boolean field to indicate if the results were truncated |
| # based on the limit parameter. |
| "stats": { # This message type encapsulates a data node as represented below: # This field contains a stats results. |
| # { |
| # "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. |
| "data": [ |
| "", |
| ], |
| }, |
| "TimeUnit": [ # This field contains a list of time unit values. Time unit refers to |
| # an epoch timestamp value. |
| "A String", |
| ], |
| "metaData": { # This message type encapsulates additional information about query execution. # This field contains metadata information about the query executed |
| "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" |
| # ] |
| "A String", |
| ], |
| "errors": [ # List of error messages as strings. |
| "A String", |
| ], |
| }, |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
