Read every figure your home draws - who needs you, security, devices, checks and today's counters
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/now';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/now \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Every figure the shell and the home draw, each from the records its own page lists: who needs you, the security reading, the devices reporting, the checks by verdict and today’s live counters.
object
Example generated
{ "at": "example", "needsYou": { "count": 1, "ids": [ "example" ], "toApprove": 1, "toActOn": 1 }, "security": { "score": 1, "areas": { "read": 1, "of": 1 }, "openIncidents": 1, "critical": 1, "worst": { "id": "example", "title": "example", "severity": "example", "href": "example" }, "sentence": "example" }, "devices": { "enrolled": 1, "reporting": 1, "recognised": 1 }, "monitors": { "checks": 1, "up": 1, "failing": 1, "waiting": 1 }, "counters": { "since": "example", "checksLastMinute": 1, "checksToday": 1, "fixesProvedToday": 1, "handledWithoutYouToday": 1 }, "refused": [ "example" ]}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.