Data
Data export and delete.
2 endpoints.
GET
/v1/data/requestsData Request List
Needs a key or a dashboard session
Responses
- 200Successful Response
DataRequestOut[]
POST
/v1/data/requestsGDPR-style export or delete of all store data
Needs a key or a dashboard session
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | null | no | Unique per logical write (8-255 chars). Retries with the same key are safe. · pattern ^[A-Za-z0-9_\-:.]{8,255}$ |
Request body application/json DataRequestIn
| Name | Type | Required | Description |
|---|---|---|---|
kind | "export" | "delete" | yes | |
confirm_slug | string | null | no | delete only: must equal the tenant slug. |
Responses
- 202Successful Response
DataRequestOut
Data shapes on this page
DataRequestOut
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
kind | "export" | "delete" | yes | |
status | "queued" | "running" | "succeeded" | "failed" | yes | |
created_at | string (date-time) | yes | |
completed_at | string (date-time) | null | no | |
download_url | string | null | no | export only: a signed BlobStore URL, valid 24 h (ADR 0018). |
job | Job | null | no |
Job
A row of the shared `jobs` table. Poll GET /v1/jobs/{id} until status is terminal.
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
kind | "reindex" | "import" | "sync" | "translate_backfill" | "translate_writeback" | "export" | "data_export" | "data_delete" | "embed" | "synonym_mining" | yes | |
status | "queued" | "running" | "succeeded" | "failed" | "canceled" | yes | |
progress | number | no | default 0 · min 0 · max 1 |
created_at | string (date-time) | yes | |
started_at | string (date-time) | null | no | |
finished_at | string (date-time) | null | no | |
result | object | null | no | |
error | string | null | no |
DataRequestIn
| Name | Type | Required | Description |
|---|---|---|---|
kind | "export" | "delete" | yes | |
confirm_slug | string | null | no | delete only: must equal the tenant slug. |