Developers
Exports4

List exports

GET/exports

Lists the exports of the current account using cursor-based pagination. The collection can be filtered by resource. Exports requested outside the API are also listed, with file_id set to null.

Exports never include a download URL. To download a file, request a short-lived download link for its file_id from the files API.

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
resource?string

Only exports of this kind of data.

Value in

  • "users"
  • "user_activity"

Header Parameters

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

curl -X GET "https://example.com/exports"
{  "data": [    {      "columns": [        "string"      ],      "consistency": {        "snapshot_at": "2019-08-24T14:15:22Z"      },      "created_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "failure_reason": "string",      "file_id": "string",      "filters": {        "access": "string",        "delivery_id": "string",        "product_id": [          "string"        ],        "showcase_id": "string",        "status": "string",        "tag_id": [          "string"        ],        "type": "string"      },      "id": "string",      "object": "export",      "operation_id": "string",      "resource": "users",      "status": "queued",      "total": 0    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Exports4

Exports in API v3: list exports, create an export, retrieve an export, delete an export.

Create an export POST

Requests a data export. The file is generated asynchronously by an `export.generate` operation, whose ID is returned in `operation_id`; use the retrieve operation to follow the export status. Each entry in `columns` must belong to the column catalog of the selected `resource`, and `filters` accepts the same keys as the users collection: `product_id`, `tag_id`, `showcase_id`, `delivery_id`, `access`, `type`, and `status`. Unknown columns or filters are rejected with a validation error. Requesting personal data columns (`email`, `document`, or `phone`) also requires the `users.read_personal` permission. Without it, the request is rejected with `permission_denied` instead of silently omitting those columns. The generated file is a UTF-8 CSV and is retained for 7 days.