Skip to content

See what Xovris saved you this month - the time and money, at your own rate if you give one

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

A token that can read is enough.

Done.

Media typeapplication/json
object
done
required
object
incidents
required
number
requests
required
number
other
required
number
prevented
required
number
rate
required
One of:
object
what
required
string
source
required
string
url
required
string
read
required
string
amountMinor
required
number
currency
required
string
ownRate
required
boolean
paid
required
One of:
object
amountMinor
required
number
currency
required
string
from
required
string
Allowed values: invoices list_price
paidForItself
required
One of:
number
sentence
required
string
month
required
string
fixes
required
number
outside
required
number
measured
required
number
notMeasured
required
Array<string>
slower
required
Array<string>
secondsSaved
required
number
hoursSaved
required
number
downtimeMinutes
required
number
currency
required
One of:
string
timeMoneyMinor
required
One of:
number
downtimeMoneyMinor
required
One of:
number
totalMinor
required
One of:
number
refused
required
One of:
string
words
required
string

Example

{  "done": {    "incidents": 1,    "requests": 1,    "other": 1  },  "prevented": 1,  "rate": {    "what": "string",    "source": "string",    "url": "string",    "read": "string",    "amountMinor": 1,    "currency": "string"  },  "ownRate": true,  "paid": {    "amountMinor": 1,    "currency": "string",    "from": "invoices"  },  "paidForItself": 1,  "sentence": "string",  "month": "string",  "fixes": 1,  "outside": 1,  "measured": 1,  "notMeasured": [    "string"  ],  "slower": [    "string"  ],  "secondsSaved": 1,  "hoursSaved": 1,  "downtimeMinutes": 1,  "currency": "string",  "timeMoneyMinor": 1,  "downtimeMoneyMinor": 1,  "totalMinor": 1,  "refused": "string",  "words": "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.