Skip to content
SIBISIBI Developers
Esc
↑↓navigate↵open⌘Jpreview

Get export

One export by its id, with its current status. While it is succeeded, the response carries download: a signed URL for the file that is valid for a short time — read the export again for a fresh one. Responds 404 when no export with that id exists.

GET/exports/{id}
Authorization
AuthorizationBearer token · headerrequired

A Sibi Public API token or access token, sent as Authorization: Bearer <token>.

Scopes:read:asset-exports
Path parameters
idstringrequired
min length 1
Responses
200

The export

idstringrequired

Sibi assigned identifier for this export.

statusstringrequired

in_progress (the export is queued or the file is being written), succeeded (the file is ready to download), or failed (see error).

Allowed:in_progresssucceededfailed
createdAtstring<date-time>required

When the export was requested.

startedAtstring<date-time>

When work on the file began. Absent while the export is still queued.

completedAtstring<date-time>

When the export succeeded or failed.

rowCountinteger

The number of assets in the file. Present once the export has succeeded.

min 0
fileSizeinteger

The size of the compressed file in bytes. Present once the export has succeeded.

min 0
downloadExportDownload

How to fetch the file. Present only while the export is succeeded.

Show properties
urlstring<uri>required

A signed URL for the export file. It is valid until expiresAt; read the export again for a fresh one.

methodstringrequired
Allowed:GET
expiresAtstring<date-time>required

When this download URL stops working.

errorobject

Why the export failed. Present only when the export is failed.

Show properties
codestringrequired
messagestringrequired
400

Invalid input parameters (VALIDATION_ERROR)

codestringrequired
Allowed:VALIDATION_ERROR
messagestringrequired
detailsobject[]required

Per-field validation errors

Show properties
Array of object
fieldstringrequired
errorstringrequired
requestIdstring

Request id for this call — quote it when contacting support

401

The Authorization header is missing, or the bearer token could not be resolved (invalid, expired, or revoked)

codestringrequired

Machine-readable error code

Allowed:UNAUTHORIZED
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

403

The token is missing the scope this operation requires (INSUFFICIENT_SCOPE), is a GraphQL token rather than a REST API token (REST_TOKEN_REQUIRED), or it was minted for the other environment (TOKEN_ENVIRONMENT_MISMATCH)

codestringrequired

Machine-readable error code

Allowed:INSUFFICIENT_SCOPEREST_TOKEN_REQUIREDTOKEN_ENVIRONMENT_MISMATCH
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

404

No export with this id exists

codestringrequired

Machine-readable error code

Allowed:EXPORT_NOT_FOUND
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

500

Internal server error

codestringrequired

Machine-readable error code

Allowed:INTERNAL_SERVER_ERROR
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

503

The token-exchange service is unavailable or misconfigured — retry shortly. Not a token problem.

codestringrequired

Machine-readable error code

Allowed:AUTH_UNAVAILABLE
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

Request
curl -X GET "https://api.sibipro.com/assets/exports/ae_aBcD1234" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "id": "ae_aBcD1234",
  "status": "in_progress",
  "createdAt": "2019-08-24T14:15:22Z",
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "rowCount": 0,
  "fileSize": 0,
  "download": {
    "url": "http://example.com",
    "method": "GET",
    "expiresAt": "2019-08-24T14:15:22Z"
  },
  "error": {
    "code": "EXPORT_GENERATION_FAILED",
    "message": "string"
  }
}