Data -- Exports

Export Query (async)

Submits an async export of a saved query as CSV or JSONL. Returns immediately with a job id; poll the status endpoint for the download URLs.

post/data/projects/{projectId}/queries/{queryId}/exports

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/{queryId}/exports
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the Project

queryIdstring required

ID of the Query

Request body

format'CSV' | 'JSONL'

Output format

limitinteger

Row limit; clamped to [1, 1000000]

includeSystemColumnsboolean

When false, Peaka system columns (_id, _version, …) are excluded. Cache plumbing columns (q, cache) are always dropped.

columnsstring[]

Explicit column selection; an unknown name yields 400. Omit to export all columns.

compression'NONE' | 'GZIP'

Output compression; with GZIP every artifact is a gzip stream carrying a .gz suffix

Example request

{
  "format": "CSV",
  "limit": 100000,
  "csvOptions": {
    "delimiter": ",",
    "quoteChar": "\"",
    "recordSeparator": "\\n",
    "includeHeader": true
  },
  "includeSystemColumns": true,
  "columns": [
    "id",
    "created",
    "amount"
  ],
  "compression": "NONE"
}

Response

Export job accepted

idstring

Export job id

statusstring

Initial job status

Example response

{
  "id": "4c9fcb44-126a-45f8-99a0-f1d245083d78",
  "status": "PENDING"
}

Changes

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