Skip to content

Read a check's results over time

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
ok
required
boolean
check
required
object
id
required
string
kind
required
string
Allowed values: tls http dns tcp udp icmp api browser
target
required
string
intervalMs
required
number
locations
required
Array<string>
locationPlaces
required
Array<object>
object
id
required
string
place
required
One of:
string
lat
required
One of:
number
lon
required
One of:
number
slots
required
Array<object>
object
place
required
One of:
string
locationId
required
string
nextRunAt
required
string
lastRunId
required
One of:
string
lastCompletedAt
required
One of:
string
lastOutcome
required
One of:
string
timeline
required
Array<object>
object
id
required
string
tenantId
required
string
kind
required
string
Allowed values: teardown_failed verdict registration heartbeat
checkId
required
One of:
string
deliver
required
boolean
payload
required
One of:
object
kind
required
string
Allowed values: verdict
tenantId
required
string
checkId
required
string
assetId
required
One of:
string
checkKind
required
string
area
string
target
required
string
from
required
string
Allowed values: no_data up degraded regional down
to
required
string
Allowed values: no_data up degraded regional down
status
required
string
Allowed values: firing resolved changed
failureClass
required
string
headline
required
string
evidenceLines
required
Array<string>
exactError
string
intervalStart
required
string
occurredAt
required
string
votes
required
Array<object>
object
locationId
required
string
place
required
string
provider
required
string
outcome
required
string
Allowed values: no_data slow expiring pass excluded fail
runId
required
One of:
string
failedPhase
required
One of:
string
excludedReason
string
healthyCount
required
number
failingCount
required
number
regionalLocations
required
Array<string>
providerNote
string
at
required
string
attempts
required
number
deliveredAt
required
One of:
string
record
required
One of:
object
longestUp
required
One of:
object
from
required
string
to
required
One of:
string
ms
required
number
down
required
object
from
required
string
ms
required
number
longestMs
required
number
periods
required
number

Example

{  "ok": true,  "check": {    "id": "string",    "kind": "tls",    "target": "string",    "intervalMs": 1,    "locations": [      "string"    ],    "locationPlaces": [      {        "id": "string",        "place": "string",        "lat": 1,        "lon": 1      }    ]  },  "slots": [    {      "place": "string",      "locationId": "string",      "nextRunAt": "string",      "lastRunId": "string",      "lastCompletedAt": "string",      "lastOutcome": "string"    }  ],  "timeline": [    {      "id": "string",      "tenantId": "string",      "kind": "teardown_failed",      "checkId": "string",      "deliver": true,      "payload": {        "kind": "verdict",        "tenantId": "string",        "checkId": "string",        "assetId": "string",        "checkKind": "string",        "area": "string",        "target": "string",        "from": "no_data",        "to": "no_data",        "status": "firing",        "failureClass": "string",        "headline": "string",        "evidenceLines": [          "string"        ],        "exactError": "string",        "intervalStart": "string",        "occurredAt": "string",        "votes": [          {            "locationId": "string",            "place": "string",            "provider": "string",            "outcome": "no_data",            "runId": "string",            "failedPhase": "string",            "excludedReason": "string"          }        ],        "healthyCount": 1,        "failingCount": 1,        "regionalLocations": [          "string"        ],        "providerNote": "string"      },      "at": "string",      "attempts": 1,      "deliveredAt": "string"    }  ],  "record": {    "longestUp": {      "from": "string",      "to": "string",      "ms": 1    },    "down": {      "from": "string",      "ms": 1,      "longestMs": 1,      "periods": 1    }  }}

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.