Skip to main content

POST /api/v1/exports

Create a new CSV export with optional filters. Exports are processed in the background.

Request Body

from
string
ISO 8601 timestamp. Export events from this time onward.
to
string
ISO 8601 timestamp. Export events up to this time.
actor_id
string
Filter exported events by actor identifier.
action
string
Filter by action.
resource
string
Filter by resource type.
tenant_id
string
Filter by tenant identifier.
session_id
string
Filter by session identifier.
Case-insensitive search across event fields.

Response

Returns 202 Accepted:
{
  "id": "exp_9c2f4a7b-1d3e-4f5a-8b6c-7d8e9f0a1b2c",
  "status": "pending",
  "filters": {
    "actor_id": "user_2hG9kLm",
    "from": "2026-03-01T00:00:00Z",
    "to": "2026-03-31T23:59:59Z"
  },
  "created_at": "2026-03-26T10:15:00Z"
}

Examples

curl -X POST https://getimmutable.dev/api/v1/exports \
  -H "Authorization: Bearer imk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "actor_id": "user_2hG9kLm",
    "from": "2026-03-01T00:00:00Z",
    "to": "2026-03-31T23:59:59Z"
  }'

Limits

  • Maximum 5 concurrent exports per workspace.
  • Each export counts toward your monthly export quota.
Events outside your retention window are not included in exports.