Skip to content

Exports endpoints

List a project’s exports

Newest first. A finished export’s download_url is a signed link, so nothing caches this.

Parameter In Type Required Notes
project_id path string (uuid) yes
limit query integer no min 1, max 200 Default 50.
cursor query string or null no
Status Description Body
200 Successful Response application/json: Page_ExportOut_
422 Validation Error application/json: HTTPValidationError

POST /api/v1/projects/{project_id}/exports

Section titled “POST /api/v1/projects/{project_id}/exports”

Request an export

Queue an export of the traces matching filters (kind: traces, the default) or of the attribution table of a window (kind: attribution, CSV only); from and to are required.

An attribution export over more than 24 hours reads the daily rollups, so a metadata key must be promoted in the project settings (422 KEY_NOT_PROMOTED otherwise).

Answers 409 NOT_CONFIGURED when object storage is not set up. Poll GET .../exports/{id} until status is done, then download from download_url.

Parameter In Type Required Notes
project_id path string (uuid) yes
Idempotency-Key header string or null no Makes a retry of this request safe: it runs once, then is replayed. min length 1, max length 128, pattern ^[\x21-\x7e]+$

Request body (application/json, required): TraceExportIn or AttributionExportIn

Status Description Body
202 Successful Response application/json: ExportOut
422 Validation Error application/json: HTTPValidationError

GET /api/v1/projects/{project_id}/exports/{export_id}

Section titled “GET /api/v1/projects/{project_id}/exports/{export_id}”

Get one export

The export’s progress. download_url is a link valid for one hour, present once done.

Anyone holding that link can download the file until it expires, so nothing caches this.

Parameter In Type Required Notes
project_id path string (uuid) yes
export_id path string (uuid) yes
Status Description Body
200 Successful Response application/json: ExportOut
422 Validation Error application/json: HTTPValidationError