Skip to content

List every check's promise worst first - broken, at risk, not yet measured, then kept - each with its objective, the share of its error budget left, the last day's burn, the alerts firing and the day the budget runs out at that pace, grouped by what it watches, over 7, 30 or 90 days, this week or this month

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

A token that can read is enough.

Done.

Media typeapplication/json
object
window
required
string
windows
required
Array<string>
Allowed values: 7d 30d 90d month week
items
required
Array<object>
object
checkId
required
string
name
required
string
kind
required
string
target
required
string
group
required
string
paused
required
boolean
objective
required
number
window
required
string
Allowed values: 7d 30d 90d month week
status
required
string
Allowed values: unmeasured kept broken at_risk
uptime
required
One of:
number
leftShare
required
One of:
number
burn
required
One of:
number
runsOutAt
required
One of:
string
sentence
required
One of:
string
firing
required
Array<object>
object
id
required
string
own
required
boolean
severity
required
string
Allowed values: page ticket
longBurn
required
number
shortBurn
required
number
setAt
required
One of:
string
groups
required
Array<object>
object
group
required
string
n
required
number
broken
required
number
atRisk
required
number
unmeasured
required
number
kept
required
number
unset
required
number
now
required
string

Example

{  "window": "string",  "windows": [    "7d"  ],  "items": [    {      "checkId": "string",      "name": "string",      "kind": "string",      "target": "string",      "group": "string",      "paused": true,      "objective": 1,      "window": "7d",      "status": "unmeasured",      "uptime": 1,      "leftShare": 1,      "burn": 1,      "runsOutAt": "string",      "sentence": "string",      "firing": [        {          "id": "string",          "own": true,          "severity": "page",          "longBurn": 1,          "shortBurn": 1        }      ],      "setAt": "string"    }  ],  "groups": [    {      "group": "string",      "n": 1,      "broken": 1,      "atRisk": 1,      "unmeasured": 1,      "kept": 1    }  ],  "unset": 1,  "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.