sql.status

Status of a SQL run

Details

Endpoint: GET /v1/execution/:execution_id/status
Credits: Free
Rate class: Light. Counts against your light requests per second.
Also called: /api/v1/execution/:execution_id/status

State of a run (QUERY_STATE_PENDING, QUERY_STATE_EXECUTING, QUERY_STATE_COMPLETED, QUERY_STATE_FAILED, QUERY_STATE_CANCELLED), its timings, result size, rows and bytes read, credits, and as_of: the checkpoint the data was at when it ran. A failed run has error.message with metadata.line and metadata.column. Pass wait_ms (max 30000) to wait for the run to finish.

Parameters

Name	Type	Description
execution_idrequired	string
wait_ms	integer

Request

Send your key in the x-api-key header, or leave it out to use the keyless tier.

curl

curl "https://api.tide.ad/v1/execution/01019A4C0F2A8B3C4D5E6F708192A3B4C5/status" \
  -H "x-api-key: YOUR_API_KEY"

TypeScript

const res = await fetch("https://api.tide.ad/v1/execution/01019A4C0F2A8B3C4D5E6F708192A3B4C5/status", {
  headers: {
    "x-api-key": process.env.TIDE_API_KEY!,
  },
});
const data = await res.json();

Response

No example response is available for this method yet.