exports

Get one export job's status and progress

Any org member. Poll this while an export runs: steps is the ordered checkpoint list and rows_done/bytes_done advance per table.

get/v1/projects/{project_id}/exports/{job_id}

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}/exports/{job_id}
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required
job_idstring required

Response

OK

attemptinteger required
bytes_doneinteger required
cancel_requestedboolean
created_atstring date-time required
finished_atstring date-time
formatstring required

native | parquet

job_idstring required
last_errorstring
query_idstring

the engine query_id of the statement most recently issued for this job

rows_doneinteger required
started_atstring date-time
statusstring required

queued | running | succeeded | failed | dead | cancelled

tablesstring[]

the requested tables; empty means the whole project database

Changes

No recorded changes to this operation across all 1 revision of this API.