Semaphor

Get an export

Returns a background export's status and progress, and failure when it failed, didn't start or was cancelled. Only the person who started the export can read it.

Codes starting with refused_ mean the export never started (for example, it has more rows than the export limit). See Export limits.

GET
/api/v1/exports/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Path Parameters

id*string

The export's ID, as the export request returned it.

Response Body

application/json

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/v1/exports/string"
{
  "id": "string",
  "status": "pending",
  "progress": 0,
  "totalRows": 0,
  "fileSize": 0,
  "failure": {
    "code": "cancelled",
    "message": "Something went wrong while running this report. Try again, and contact support if it keeps happening.",
    "detail": "string"
  },
  "error": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "deadlineAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}