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. For cross-site search, click Search all in the search results.

Get status of an asynchronous analytics query

Resource Summary

Security

Content Type

application/json, text.xml

Category

Analytics,

Getstatusofanofflinequery

GET

Get status of an asynchronous analytics query

Get the status of an asynchronous analytics query. Obtain the queryId when you created the query by using the Create an asynchronous analytics query API.

 

In the response, the value fo the state property contains the query status as either:

  • running
  • completed

If the query is still in progress, you'll get a response like this, where the state is running:

 

{
  "self": "/organizations/myorg/environments/myenv/queries/1577884c-4f48-4735-9728-5da4b05876ab",
  "state": "running",
  "created": "2016-02-23T14:07:27Z",
  "updated": "2016-02-23T14:07:54Z"
}

 

After the query has completed successfully, you will see a response like this, where state is set to completed:

{
  "self": "/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd",
  "state": "completed",
  "result": {
    "self": "/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result",
    "expires": "2017-05-22T14:56:31Z"
  },
  "resultRows": 1,
  "resultFileSize": "922KB",
  "executionTime": "11 sec",
  "created": "2016-05-10T07:11:10Z",
  "updated": "2016-05-10T07:13:22Z"
}

 

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/{queryId}

Request Body

org_name Mention the organization name true

env_name Mention the environment name true

queryId Mention the query ID 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?)