Skip to content

Read where each export stands, reconciled

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/exports
curl --request GET \  --url https://api.xovris.ai/v1/exports \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
notYet
string
schemaVersion
required
string
exports
required
Array<object>
object
destinationId
required
string
location
required
string
enabled
required
boolean
promisedDelaySeconds
required
number
startedAt
required
string
problem
required
One of:
string
datasets
required
Array<object>
object
largestDelaySeconds
required
One of:
number
withinPromise
required
One of:
boolean
lastWrittenAt
required
One of:
string
iceberg
required
One of:
object
metadata
required
string
snapshotId
required
string
committedAt
required
string
register
required
string
rowsXovrisHolds
number
reconciles
boolean
dataset
required
string
exportedUntil
required
One of:
string
objects
required
number
rowsWritten
required
number
deletesPropagated
required
number
rowsYourBucketShouldHold
required
number

Example

{  "notYet": "string",  "schemaVersion": "string",  "exports": [    {      "destinationId": "string",      "location": "string",      "enabled": true,      "promisedDelaySeconds": 1,      "startedAt": "string",      "problem": "string",      "datasets": [        {          "largestDelaySeconds": 1,          "withinPromise": true,          "lastWrittenAt": "string",          "iceberg": {            "metadata": "string",            "snapshotId": "string",            "committedAt": "string",            "register": "string"          },          "rowsXovrisHolds": 1,          "reconciles": true,          "dataset": "string",          "exportedUntil": "string",          "objects": 1,          "rowsWritten": 1,          "deletesPropagated": 1,          "rowsYourBucketShouldHold": 1        }      ]    }  ]}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.