Download results

Downloads query results in various formats with custom formatting options

POST /api/v2/projects/{projectUuid}/query/{queryUuid}/schedule-download

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "jobId": "<string>"
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

queryUuid · string · required

The UUID of the completed async query to download

Body

application/json

Construct a type with the properties of T except for those in type K.

type · enum<string>

Available options: csv, image, jsonl, s3_jsonl, xlsx

pivotConfig · object

Show child attributes

onlyRaw · boolean

showTableNames · boolean

customLabels · object

Construct a type with a set of properties K of type T

Show child attributes

columnOrder · string[]

hiddenFields · string[]

attachmentDownloadName · string

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok