You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Create an asynchronous analytics query

Resource Summary

Security

Content Type

application/json, text.xml

Category

Analytics,

Createanofflinequery

POST

Create an asynchronous analytics query

Create an asynchronous analytics query. You must be in the role of organization administrator to call this API.

 

You can make up to seven calls per hour to this API. If you exceed the call quota, this API returns an HTTP 429 response.

 

Note: Free and trial accounts cannot create asynchronous reports. For more information on Edge pricing plans, see https://apigee.com/api-management/#/pricing.

 

See Use the asynchronous custom reports API for more information and examples.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/queries

Query Parameters

Name Values Description
tzo

By default, the timeRange parameter specifies a UTC start and end time. To change the time zone from UTC to a different time zone, use the tzo parameter to set the offset, in minutes, from UTC to the desired time zone.

For example, the East coast of the United States is in the EST time zone. To change the time zone to EST, set tzo to -240. For California, in the PST timezone, set the offset to -480 minutes. For Bangalore, in the IST timezone, set the offset to 330 minutes.

Request Body

Property Description Required?
metrics

Array of metrics. You can specify one or more metrics for a query where each metric includes. Only the metric name is required:

  • name: (Required) The name of the metric as defined by the table at metrics.
  • function: (Optional) The aggregation function as avg, min, max, or sum.

    Not all metrics support all aggregation functions. The documentation on metrics contains a table that specifies the metric name and the function (avg, min, max,sum) supported by the metric.

  • alias: (Optional) The name of the proroperty containing the metric data in the output. If omitted, it defaults to the metric name combined with the name of the aggregation function.
  • operator: (Optional) An operation to perform on the metric after its value has been calculated. Works with the value property. Supported operations include: + - / % *.
  • value: (Optional) The value applied to the calculated metric by the specified operator.

The operator and value properties define a post-processing operation performed on the metric. For example, if you specify the metric response_processing_latency, the metric returns the average response processing latency with a unit of milliseconds. To convert the units to seconds, set the operator to "/" and the value to ”1000.0“:

"metrics":[  
  {  
    "name":"response_processing_latency",
    "function":"avg",
    "alias":"average_response_time_in_seconds",
    "operator":"/",
    "value":"1000"
  }
]

For more information, see Analytics metrics, dimensions, and filters reference.

No
dimensions Array of dimensions to group the metrics. For more information, see the list of supported dimension. You can specify multiple dimensions. No
timeRange Time range for the query.

You can use the following predefined strings to specify the time range:

  • last60minutes
  • last24hours
  • last7days

Or, you can specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. For example:

"timeRange": {
    "start": "2018-07-29T00:13:00Z",
    "end": "2018-08-01T00:18:00Z"
}
Yes
limit Maximum number of rows that can be returned in the result. No
filter 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 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. No
groupByTimeUnit 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.

No
outputFormat Output format. Valid values include: csv or json. Defaults to json.

Note: Configure the delimiter for CSV output using the csvDelimiter property.

No
csvDelimiter 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). No

org_name Mention the organization name true

env_name Mention the environment name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)