Get query status

  • Updated on Sep 2, 2025
  • Published on Sep 2, 2025
Prev Next
Get
/query/status

Get status and results for an asynchronous query execution

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Query parameters
json
Required
object
api_key
string

API key when not using an authorization header

schedule_id
string Required

Schedule ID for the query

offset_start
integer

Starting row index for paginated response

Default0
offset_end
integer

Ending row index for paginated response

Responses
200

Query status retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

schedule_id
string

Query schedule ID

status_code
string

Status code for the query

Valid values[ "SCHEDULED", "QUEUED", "RUNNING", "SUCCESS", "FAILURE", "STOPPED" ]
progress
object
queries_ready
integer

Number of sub-queries performed for this query

queries_total
integer

Number of sub-queries scheduled for this query (can increase as query progresses)

workflow
object
tasks_scheduled
integer

Number of query tasks scheduled to your license queue

tasks_running
integer

Number of query tasks running in your license queue

data
Array of object

Query results (empty array when not in SUCCESS state)

object
404

Query status not found

object
error
string

Error code indicating the query status was not found

Valid values[ "STATUS_NOT_FOUND" ]