ExportJobDto

Example

JSON

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "pending",
  "surface": "admin",
  "format": "csv",
  "application_id": "00000000-0000-0000-0000-000000000000",
  "environment_id": "00000000-0000-0000-0000-000000000000",
  "row_count": 0,
  "error": "string",
  "created_at": "2026-04-20T12:00:00.000Z",
  "completed_at": "2026-04-20T12:00:00.000Z",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "download_url": "string"
}

Properties

12 properties 5 required

id string Required

format: uuid

status enum Required

`pending` (enqueued), `processing` (worker rendering), `completed` (file ready), or `failed` (see `error`).

Enumpendingprocessingcompletedfailed

surface enum Required

The audit surface the export was taken from.

Enumadminidentities

format enum Required

Wire format of the rendered file.

Enumcsvndjson

application_id string Optional

format: uuidnullable

environment_id string Optional

format: uuidnullable

row_count number Optional

Rows written, set once the job completes.

nullable

error string Optional

Failure detail, present only when `status` is `failed`.

nullable

created_at string Required

format: date-time

completed_at string Optional

format: date-timenullable

expires_at string Optional

When the stored file + this record become eligible for sweep.

format: date-timenullable

download_url string Optional

Short-lived signed download URL. Present only on the single-job read of a completed job; `null` otherwise.

nullable

Was this page helpful?

Tell us how we can improve this guide.