Skip to content
AiKYNETIX

A client's latest data export (owner-only)

GET
/api/clients/{id}/export/
curl --request GET \
  --url http://localhost:8000/api/clients/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/export/ \
  --header 'Authorization: Bearer <token>'

The newest export of this client’s data and where it stands; 204 when there has been none.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

One export of a client’s data, as its team owner sees it.

object
id
required
string format: uuid
status
required
string
Allowed values: received in_progress completed failed cancelled
client_id
required
string format: uuid
nullable
client_name
required

The client’s name while the client exists; empty after.

string
requested_at
required
string format: date-time
completed_at
required
string format: date-time
nullable
expires_at
required

When the archive is deleted; null until it is built.

string format: date-time
nullable
bytes
required
integer
nullable
download_url
required

A link to the archive (a ZIP) while it is kept; null otherwise.

string
nullable
failure_code
required

Why a failed export failed: too_large (more video and files, by size, than an automatic export may hold — ask support), gone (the client was deleted or erased), or error (including a run that was interrupted). Null unless status is failed.

string
nullable

Example 

{
  "status": "received"
}

204

Section titled “204”

No response body

403

Section titled “403”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example generated

{
  "detail": "example"
}

404

Section titled “404”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example generated

{
  "detail": "example"
}