databaseSnapshots

Get Query Status

Retrieves a query's status.

This method requires a query ID, which you can get only from the Run Query response.

When a query is completed, you can retrieve the query results in one of these ways:

  • Following the outputLocation URI in this method's response object. The URI points to where the results are stored as a CSV file.
  • Calling Get Query Result. Get Query Result returns a paginated array of results as JSON for additional processing or handling.

If the query failed, see Troubleshooting Queries for possible errors and how to resolve them.

get/v1/projects/{projectId}/queries/{queryId}/status

Request

  • Base URL: https://%7Baccount-domain%7D.console.eon.io/api
  • URL: https://%7Baccount-domain%7D.console.eon.io/api/v1/projects/{projectId}/queries/{queryId}/status
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

ID of the project that contains the query status you want to retrieve. You can see your project ID in the API Credentials page in your global management console.

queryIdstring required

Query ID returned by Run Query.

Response

Query status retrieved.

runningTimeMsinteger

Time the query took to run, in milliseconds.

status'UNSPECIFIED' | 'IN_PROGRESS' | 'COMPLETED' | 'CANCELED' | 'FAILED' required

Query status. If completed, the query results can be retrieved. UNSPECIFIED is supported only in responses.

errorMessagestring nullable

Error message. Present only if the status is FAILED.

outputLocationsstring[]

Locations where the query results are saved to. This is set by destination in the Run Query request body.

Changes

No recorded changes to this operation across all 1 revision of this API.