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.
const url = 'https://api.xovris.ai/v1/checks/example/timeline';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/checks/example/timeline \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.