Developers
Exports4

Delete an export

DELETE/exports/{export_id}

Permanently deletes the generated file immediately and moves the export to the trash.

Generated files do not expire. Use this operation to remove exported data that is no longer needed.

Authorization

AuthorizationBearer <token>

Credential: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

export_id*string

Public ID of the export, prefixed with exp_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/exports/string"
Empty

Retrieve an export GET

Retrieves an export by its public ID. When generation finishes, `status` becomes `completed` and the response includes `file_id` and `total`. If generation fails, `status` becomes `failed` and `failure_reason` describes the cause. Generated files do not expire: the file is kept until the export is deleted, and `expires_at` is `null`. The `expired` status applies only to exports generated while files were retained for 7 days; their file no longer exists and `file_id` is `null`. The export never includes a download URL. To download the file, request a download link for `file_id` from the files API.

Reports12

Next Page