staqlydocs
REST APIAPI referenceAuth

Export job status

Export job status (admin)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/workspace/exports/{id}

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Response Body

OK

application/json
  1. response
id*string
status*string
Value in"pending""running""ready""failed""expired"
includes_media*boolean

false for a data-only export (Starter): no media/ files in the ZIP

size_bytes*integer
error?string
created_at*string
Formatdate-time
started_at*|
Formatdate-time
finished_at*|
Formatdate-time
expires_at*string
Formatdate-time
download_url?string

Relative URL, present when status is ready

curl -X GET 'https://staqly.example.com/v1/workspace/exports/string'
{  "id": "string",  "status": "pending",  "includes_media": true,  "size_bytes": 0,  "error": "string",  "created_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "download_url": "string"}