get /organizations/{org_name}/environments/{env_name}/queries

Lists the asynchronous analytics queries for an environment.

HTTP request

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

Path Parameters

org_name (required)

string

Organization name.

env_name (required)

string

Environment name.

Query Parameters

submittedBy

string

Filter response by email address of user who submitted the queries.

status

string

Filter response list by asynchronous query status.

dataset

string

Filter response list by dataset type, api or mint. By default, all datasets are returned.

inclQueriesWithoutReport

string

If true, include asynchronous queries that don't have a report definition.

Response Types

200: 

OK

Body

application/json

Example

{
"self": "/organizations/myorg/environments/test/queries/b23415d7-edd0-4c84-99e4-e4dc790f723b",
"state": "completed",
"userId": "ahamilton@example.com",
"result": {
"self": "/organizations/myorg/environments/test/queries/b23415d7-edd0-4c84-99e4-e4dc790f723b/result",
"expires": "2020-10-13T19:46:44Z"
},
"resultFileSize": "0.02 KB",
"resultRows": "0",
"executionTime": "10 seconds",
"queryParams": {
"dimensions": [
"apiproxy"
],
"endTimestamp": "2020-10-06T19:46:30.006Z",
"metrics": [
"name:message_count,func:sum,alias:sum_txn"
],
"startTimestamp": "2020-10-05T19:46:30.006Z"
},
"created": "2020-10-06T19:46:30Z",
"updated": "2020-10-06T19:46:44Z"
}
array

List of asynchronous analytics queries.

Query

Status of asynchronous analytics query. When you create an asynchronous analytics query initially, only the created, self, and state values are returned in the response.

created

string

Date and time the asynchronous analytics query was created.

error

string

Flag that specifies whether or not an error was encountered.

executionTime

string

Time required to execute asynchronous analytics query in the ISO format: yyyy-mm-ddThh:mm:ssZ.

result

object

Result information. Provided when state is set to completed.

expires

string

Date and time the asynchronous analytics query expires in the ISO format: yyyy-mm-ddThh:mm:ssZ.

self

string

URL to access the asynchronous analytics query result.

resultFileSize

string

File size in KBs of the asynchronous analytics query results. Provided when state is set to completed.

resultRows

integer

Number of rows in the asynchronous analytics query results. Provided when state is set to completed.

self

string

URL to access the asynchronous analytics query results.

state

string

Status of the asynchronous analytics query. Valid values include enqueued, running, and completed.

updated

string

Date and time the asynchronous analytics query was created in the ISO format: yyyy-mm-ddThh:mm:ssZ.

400: 

Bad request

Authentication Requirements

For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)

Key location: header
Parameter name: Authorization
Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
env_name
submittedBy
status
dataset
inclQueriesWithoutReport
Credentials
Multi-factor authentication is not supported.