Skip to content

See how each feature compares with the leading tools in its area

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

A token that can read is enough.

Done.

Media typeapplication/json
object
listedOn
required
string
period
required
object
from
required
string
to
required
string
red
required
Array<string>
features
required
Array<object>
object
area
required
string
name
required
string
red
required
boolean
leadersWinning
required
Array<string>
measures
required
Array<object>
object
measure
required
string
Allowed values: coverage cost time_to_fix time_to_detect false_alarms
xovris
required
One of:
object
value
required
number
n
required
number
unit
required
string
source
required
string
leaders
required
Array<object>
object
leader
required
string
value
required
One of:
number
unit
required
One of:
string
source
required
One of:
string
date
required
One of:
string
verdict
required
string
Allowed values: UNMEASURED xovris_wins leader_wins tie
why
required
string
unmeasured
required
number
reproduce
required
string

Example

{  "listedOn": "string",  "period": {    "from": "string",    "to": "string"  },  "red": [    "string"  ],  "features": [    {      "area": "string",      "name": "string",      "red": true,      "leadersWinning": [        "string"      ],      "measures": [        {          "measure": "coverage",          "xovris": {            "value": 1,            "n": 1,            "unit": "string",            "source": "string"          },          "leaders": [            {              "leader": "string",              "value": 1,              "unit": "string",              "source": "string",              "date": "string",              "verdict": "UNMEASURED",              "why": "string"            }          ]        }      ],      "unmeasured": 1    }  ],  "reproduce": "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.