| <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.queries.html">queries</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Submit a query to be processed in the background.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get query status</p> |
| <p class="toc_element"> |
| <code><a href="#getResult">getResult(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">After the query is completed, use this API to retrieve the results.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, dataset=None, submittedBy=None, from=None, to=None, status=None, inclQueriesWithoutReport=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Return a list of Asynchronous Queries</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Submit a query to be processed in the background. |
| If the submission of the query succeeds, the API returns a 201 status and |
| an ID that refer to the query. In addition to the HTTP status 201, the |
| `state` of "enqueued" means that the request succeeded. |
| |
| Args: |
| parent: string, Required. The parent resource name. |
| Must be of the form `organizations/{org}/environments/{env}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "metrics": [ # A list of Metrics. |
| { # More info about Metric: |
| # https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics |
| "function": "A String", # Aggregation function: avg, min, max, or sum. |
| "alias": "A String", # Alias for the metric. Alias will be used to replace metric name |
| # in query results. |
| "operator": "A String", # One of `+`, `-`, `/`, `%`, `*`. |
| "name": "A String", # Required. Metric name. |
| "value": "A String", # Operand value should be provided when operator is set. |
| }, |
| ], |
| "name": "A String", # Asynchronous Query Name. |
| "timeRange": "", # Required. Time range for the query. |
| # Can use the following predefined strings to specify the time range: |
| # `last60minutes` |
| # `last24hours` |
| # `last7days` |
| # Or, specify the timeRange as a structure describing start and end |
| # timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. |
| # |
| # Example: |
| # "timeRange": { |
| # "start": "2018-07-29T00:13:00Z", |
| # "end": "2018-08-01T00:18:00Z" |
| # } |
| "outputFormat": "A String", # Valid values include: `csv` or `json`. Defaults to `json`. |
| # Note: Configure the delimiter for CSV output using the csvDelimiter |
| # property. |
| "dimensions": [ # A list of dimensions. |
| # https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions |
| "A String", |
| ], |
| "csvDelimiter": "A String", # Delimiter used in the CSV file, if `outputFormat` is set |
| # to `csv`. Defaults to the `,` (comma) character. |
| # Supported delimiter characters include comma (`,`), pipe (`|`), |
| # and tab (`\t`). |
| "reportDefinitionId": "A String", # Asynchronous Report ID. |
| "groupByTimeUnit": "A String", # Time unit used to group the result set. |
| # Valid values include: second, minute, hour, day, week, or month. |
| # If a query includes groupByTimeUnit, then the result is an aggregation |
| # based on the specified time unit and the resultant timestamp does not |
| # include milliseconds precision. |
| # If a query omits groupByTimeUnit, then the resultant timestamp includes |
| # milliseconds precision. |
| "filter": "A String", # Boolean expression that can be used to filter data. |
| # Filter expressions can be combined using AND/OR terms and should be fully |
| # parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and |
| # filters reference |
| # https://docs.apigee.com/api-platform/analytics/analytics-reference |
| # for more information on the fields available to filter |
| # on. For more information on the tokens that you use to build filter |
| # expressions, see Filter expression syntax. |
| # https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax |
| "limit": 42, # Maximum number of rows that can be returned in the result. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "updated": "A String", # Last updated timestamp for the query. |
| "reportDefinitionId": "A String", # Asynchronous Report ID. |
| "resultRows": "A String", # ResultRows is available only after the query is completed. |
| "executionTime": "A String", # ExecutionTime is available only after the query is completed. |
| "state": "A String", # Query state could be "enqueued", "running", "completed", "failed". |
| "self": "A String", # Self link of the query. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` |
| "error": "A String", # Error is set when query fails. |
| "resultFileSize": "A String", # ResultFileSize is available only after the query is completed. |
| "name": "A String", # Asynchronous Query Name. |
| "created": "A String", # Creation time of the query. |
| "result": { # Result is available only after the query is completed. |
| "expires": "A String", # Query result will be unaccessable after this time. |
| "self": "A String", # Self link of the query results. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` |
| }, |
| "queryParams": { # Contains information like metrics, dimenstions etc of the AsyncQuery. |
| "metrics": [ # Metrics of the AsyncQuery. |
| # |
| # Example: ["name:message_count,func:sum,alias:sum_message_count"] |
| "A String", |
| ], |
| "endTimestamp": "A String", # End timestamp of the query range. |
| "outputFormat": "A String", # Output format. |
| "timeUnit": "A String", # Query GroupBy time unit. |
| "dimensions": [ # Dimensions of the AsyncQuery. |
| "A String", |
| ], |
| "startTimestamp": "A String", # Start timestamp of the query range. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get query status |
| If the query is still in progress, the `state` is set to "running" |
| After the query has completed successfully, `state` is set to "completed" |
| |
| Args: |
| name: string, Required. Name of the asynchronous query to get. Must be of the form |
| `organizations/{org}/environments/{env}/queries/{queryId}`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "updated": "A String", # Last updated timestamp for the query. |
| "reportDefinitionId": "A String", # Asynchronous Report ID. |
| "resultRows": "A String", # ResultRows is available only after the query is completed. |
| "executionTime": "A String", # ExecutionTime is available only after the query is completed. |
| "state": "A String", # Query state could be "enqueued", "running", "completed", "failed". |
| "self": "A String", # Self link of the query. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` |
| "error": "A String", # Error is set when query fails. |
| "resultFileSize": "A String", # ResultFileSize is available only after the query is completed. |
| "name": "A String", # Asynchronous Query Name. |
| "created": "A String", # Creation time of the query. |
| "result": { # Result is available only after the query is completed. |
| "expires": "A String", # Query result will be unaccessable after this time. |
| "self": "A String", # Self link of the query results. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` |
| }, |
| "queryParams": { # Contains information like metrics, dimenstions etc of the AsyncQuery. |
| "metrics": [ # Metrics of the AsyncQuery. |
| # |
| # Example: ["name:message_count,func:sum,alias:sum_message_count"] |
| "A String", |
| ], |
| "endTimestamp": "A String", # End timestamp of the query range. |
| "outputFormat": "A String", # Output format. |
| "timeUnit": "A String", # Query GroupBy time unit. |
| "dimensions": [ # Dimensions of the AsyncQuery. |
| "A String", |
| ], |
| "startTimestamp": "A String", # Start timestamp of the query range. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getResult">getResult(name, x__xgafv=None)</code> |
| <pre>After the query is completed, use this API to retrieve the results. |
| If the request succeeds, and there is a non-zero result set, the result is |
| downloaded to the client as a zipped JSON file. |
| The name of the downloaded file will be: |
| OfflineQueryResult-<query-id>.zip |
| |
| Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` |
| |
| Args: |
| name: string, Required. Name of the asynchronous query result to get. Must be of the |
| form `organizations/{org}/environments/{env}/queries/{queryId}/result`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Message that represents an arbitrary HTTP body. It should only be used for |
| # payload formats that can't be represented as JSON, such as raw binary or |
| # an HTML page. |
| # |
| # |
| # This message can be used both in streaming and non-streaming API methods in |
| # the request as well as the response. |
| # |
| # It can be used as a top-level request field, which is convenient if one |
| # wants to extract parameters from either the URL or HTTP template into the |
| # request fields and also want access to the raw HTTP body. |
| # |
| # Example: |
| # |
| # message GetResourceRequest { |
| # // A unique request id. |
| # string request_id = 1; |
| # |
| # // The raw HTTP body is bound to this field. |
| # google.api.HttpBody http_body = 2; |
| # } |
| # |
| # service ResourceService { |
| # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); |
| # rpc UpdateResource(google.api.HttpBody) returns |
| # (google.protobuf.Empty); |
| # } |
| # |
| # Example with streaming methods: |
| # |
| # service CaldavService { |
| # rpc GetCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # rpc UpdateCalendar(stream google.api.HttpBody) |
| # returns (stream google.api.HttpBody); |
| # } |
| # |
| # Use of this type only changes how the request and response bodies are |
| # handled, all other features will continue to work unchanged. |
| "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body. |
| "data": "A String", # The HTTP request/response body as raw binary. |
| "extensions": [ # Application specific response metadata. Must be set in the first response |
| # for streaming APIs. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, dataset=None, submittedBy=None, from=None, to=None, status=None, inclQueriesWithoutReport=None, x__xgafv=None)</code> |
| <pre>Return a list of Asynchronous Queries |
| |
| Args: |
| parent: string, Required. The parent resource name. |
| Must be of the form `organizations/{org}/environments/{env}`. (required) |
| dataset: string, Filter response list by dataset. |
| |
| Example: `api`, `mint` |
| submittedBy: string, Filter response list by user who submitted queries. |
| from: string, Filter response list by returning asynchronous queries that |
| created after this date time. |
| Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. |
| to: string, Filter response list by returning asynchronous queries that |
| created before this date time. |
| Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. |
| status: string, Filter response list by asynchronous query status. |
| inclQueriesWithoutReport: string, Flag to include asynchronous queries that don't have a report denifition. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response for ListAsyncQueries. |
| "queries": [ # The asynchronous queries belong to requested resource name. |
| { |
| "updated": "A String", # Last updated timestamp for the query. |
| "reportDefinitionId": "A String", # Asynchronous Report ID. |
| "resultRows": "A String", # ResultRows is available only after the query is completed. |
| "executionTime": "A String", # ExecutionTime is available only after the query is completed. |
| "state": "A String", # Query state could be "enqueued", "running", "completed", "failed". |
| "self": "A String", # Self link of the query. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` |
| "error": "A String", # Error is set when query fails. |
| "resultFileSize": "A String", # ResultFileSize is available only after the query is completed. |
| "name": "A String", # Asynchronous Query Name. |
| "created": "A String", # Creation time of the query. |
| "result": { # Result is available only after the query is completed. |
| "expires": "A String", # Query result will be unaccessable after this time. |
| "self": "A String", # Self link of the query results. |
| # |
| # Example: |
| # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` |
| }, |
| "queryParams": { # Contains information like metrics, dimenstions etc of the AsyncQuery. |
| "metrics": [ # Metrics of the AsyncQuery. |
| # |
| # Example: ["name:message_count,func:sum,alias:sum_message_count"] |
| "A String", |
| ], |
| "endTimestamp": "A String", # End timestamp of the query range. |
| "outputFormat": "A String", # Output format. |
| "timeUnit": "A String", # Query GroupBy time unit. |
| "dimensions": [ # Dimensions of the AsyncQuery. |
| "A String", |
| ], |
| "startTimestamp": "A String", # Start timestamp of the query range. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
