Skip to main content
POST
Cancel a background export

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the query export to cancel

Response

The query result, with status 'cancelled' when the cancel took effect (or the run's real status if it had already finished)

id
string<uuid>

Query result ID

object
enum<string>

Object type identifier

Available options:
query_result
status
enum<string>

Current status of the query. Synchronous queries return 'completed' or 'failed'.

Available options:
completed,
failed,
in_progress,
cancelled
created_at
number

Unix timestamp of when the query was created

collections
string<uuid>[]

Collection IDs the query ran over

sql
string | null

The effective SQL that was executed (echoes the request's sql)

columns
object[] | null

Result columns in select order

rows
object[] | null

Result rows as objects keyed by column name

row_count
integer

Number of rows returned

truncated
boolean

Whether the result was truncated by max_rows or the stored-result size cap

dry_run
boolean

True when the query was only validated/compiled (dry_run request): columns holds the output schema and rows is null.

usage
object | null

Dataset and timing usage for the run

error
object | null

Error details if the query failed

format
enum<string> | null

The result format ('csv'/'jsonl' for background exports)

Available options:
json,
csv,
jsonl
download_url
string | null

Signed URL to download a completed background export. Valid for 24 hours and not refreshed on read (re-run the export if it expires); null for synchronous runs and until a background export completes

download_expires_at
number | null

Unix timestamp (ms) when download_url expires

output_bytes
integer | null

Compressed size of a completed background export, in bytes