Skip to content

See the changes Xovris proposes to make your alerts quieter and sharper

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

A token that can read is enough.

Done.

Media typeapplication/json
object
proposals
required
Array<object>
object
createdAt
required
One of:
string
evidence
required
object
pages
required
number
acknowledged
required
number
acted
required
number
clearedUnaided
required
number
alertIds
required
Array
id
required
string
failureClass
required
string
sentence
required
string
pages
required
number
holds
required
Array<object>
object
id
required
string
failureClass
required
string
holdMs
required
number
active
required
boolean
evidence
required
object
alerts
required
number
clearedUnaided
required
number
share
required
number
p95Ms
required
number
sampleIds
required
Array<string>
createdAt
required
string
tunedThisWeek
required
Array<object>
object
failureClass
required
string
holdMs
required
number
active
required
boolean
evidence
required
object
alerts
required
number
clearedUnaided
required
number
share
required
number
p95Ms
required
number
sampleIds
required
Array<string>
id
required
string
summarised
required
Array<string>
now
required
string

Example

{  "proposals": [    {      "createdAt": "string",      "evidence": {        "pages": 1,        "acknowledged": 1,        "acted": 1,        "clearedUnaided": 1,        "alertIds": [          null        ]      },      "id": "string",      "failureClass": "string",      "sentence": "string",      "pages": 1    }  ],  "holds": [    {      "id": "string",      "failureClass": "string",      "holdMs": 1,      "active": true,      "evidence": {        "alerts": 1,        "clearedUnaided": 1,        "share": 1,        "p95Ms": 1,        "sampleIds": [          "string"        ]      },      "createdAt": "string"    }  ],  "tunedThisWeek": [    {      "failureClass": "string",      "holdMs": 1,      "active": true,      "evidence": {        "alerts": 1,        "clearedUnaided": 1,        "share": 1,        "p95Ms": 1,        "sampleIds": [          "string"        ]      },      "id": "string"    }  ],  "summarised": [    "string"  ],  "now": "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.