Get query status

Updated on Jun 23, 2026
Published on Dec 12, 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

JSON-encoded query status parameters

object

api_key

string

API key when not using an authorization header

Max length255

Pattern^[A-Za-z0-9_-]+$

schedule_id

string Required

Schedule ID for the query

Max length50

Pattern^[A-Za-z0-9_-]+$

offset_start

integer (int32)

Starting row index for paginated response

Minimum0

Maximum1000000

Default0

offset_end

integer (int32)

Ending row index for paginated response

Minimum0

Maximum1000000

Example{ "schedule_id": "abc123" }

Responses

200

Query status retrieved successfully

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

Expand All

object

meta

object

request_id

string

API request ID

Max length50

Pattern^[A-Za-z0-9_-]+$

schedule_id

string

Query schedule ID

Max length50

Pattern^[A-Za-z0-9_-]+$

status_code

string

Status code for the query

Valid values[ "SCHEDULED", "QUEUED", "RUNNING", "SUCCESS", "FAILURE", "STOPPED" ]

Max length20

progress

object

queries_ready

integer (int32)

Number of sub-queries performed for this query

Minimum0

Maximum10000

queries_total

integer (int32)

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

Minimum0

Maximum10000

workflow

object

tasks_scheduled

integer (int32)

Number of query tasks scheduled to your license queue

Minimum0

Maximum1000

tasks_running

integer (int32)

Number of query tasks running in your license queue

Minimum0

Maximum1000

data

Array of object

Query results (empty array when not in SUCCESS state)

Max items10000

object

400

Bad request - invalid parameters

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request was invalid."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (CommonSchemas_Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (ErrorResponse_Error)

Machine- and human-readable detail for a failed request.

code

string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

401

Unauthorized

Headers

WWW-Authenticate

string

Bearer token required

Max length255

Pattern^Bearer.*

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (CommonSchemas_Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (ErrorResponse_Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

404

Query status not found

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

object

error

string

Error code indicating the query status was not found

Valid values[ "STATUS_NOT_FOUND" ]

Max length50

429

Too Many Requests

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Retry-After

integer

Seconds until rate limit resets

Minimum1

Maximum86400

Example3600

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "TOO_MANY_REQUESTS",
    "message": "Rate limit exceeded. Retry later."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (CommonSchemas_Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (ErrorResponse_Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

500

Internal server error

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (CommonSchemas_Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (ErrorResponse_Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

Was this article helpful?

Documentation Index

Get query status