v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Queries

Wait for query results

Poll for the results of one or more query jobs. Use this endpoint when a request to the Run query endpoint times out and returns remaining_job_ids in the response.

This endpoint will wait for the specified jobs to complete and return their results. If the jobs are still processing when the request times out, the response will include the remaining job IDs to poll again.

get/v1/query/wait

Query parameters

job_idsstring[] required

An array of job IDs to poll for results. These IDs are returned in the remaining_job_ids property when a request to the Run query endpoint times out.

Format the parameter as a JSON array (e.g., ?job_ids=["job-id-1","job-id-2"]).

Response

Successful response containing the query results for completed jobs.

If all jobs have completed, timed_out will be false and the response will include the full query results.

If some jobs are still processing when this request times out, timed_out will be true and remaining_job_ids will contain the IDs of jobs that are still running. Continue polling with these IDs until all jobs complete.

job_idstring uuid

The unique identifier for the query job

statusstring

Job status (e.g., COMPLETE, PLANNED)

client_result_idstring uuid

Client-side result identifier

summaryobject

Query execution summary including SQL, stats, and field metadata

cache_metadataobject

Cache information including TTL and data freshness

queryobject

The executed query details

resultstring

Base64 encoded Apache Arrow table containing query results

remaining_job_idsstring[]

IDs of jobs still processing if this request timed out. Continue polling with these IDs.

timed_outboolean

Indicates if the request timed out. If true, use remaining_job_ids to poll again.