Skip to content

Read the export schema

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/schema
curl --request GET \  --url https://api.xovris.ai/v1/exports/schema \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
version
required
string
datasets
required
object
incidents
required
object
columns
required
Array<object>
object
name
required
string
type
required
string
Allowed values: STRING INT64 DOUBLE BOOLEAN TIMESTAMP
nullable
required
boolean
description
required
string
path
required
string
deletes
required
string
fixes
required
object
columns
required
Array<object>
object
name
required
string
type
required
string
Allowed values: STRING INT64 DOUBLE BOOLEAN TIMESTAMP
nullable
required
boolean
description
required
string
path
required
string
deletes
required
string
spans
required
object
columns
required
Array<object>
object
name
required
string
type
required
string
Allowed values: STRING INT64 DOUBLE BOOLEAN TIMESTAMP
nullable
required
boolean
description
required
string
path
required
string
deletes
required
string
metrics
required
object
columns
required
Array<object>
object
name
required
string
type
required
string
Allowed values: STRING INT64 DOUBLE BOOLEAN TIMESTAMP
nullable
required
boolean
description
required
string
path
required
string
deletes
required
string
deletes
required
string
manifests
required
string
iceberg
required
string

Example

{  "version": "string",  "datasets": {    "incidents": {      "columns": [        {          "name": "string",          "type": "STRING",          "nullable": true,          "description": "string"        }      ],      "path": "string",      "deletes": "string"    },    "fixes": {      "columns": [        {          "name": "string",          "type": "STRING",          "nullable": true,          "description": "string"        }      ],      "path": "string",      "deletes": "string"    },    "spans": {      "columns": [        {          "name": "string",          "type": "STRING",          "nullable": true,          "description": "string"        }      ],      "path": "string",      "deletes": "string"    },    "metrics": {      "columns": [        {          "name": "string",          "type": "STRING",          "nullable": true,          "description": "string"        }      ],      "path": "string",      "deletes": "string"    }  },  "deletes": "string",  "manifests": "string",  "iceberg": "string"}

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.