Read one review pass reading by reading - what it read, found and fixed
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/reviews/example';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/reviews/example \ --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
{ "sources": [ { "id": "string", "state": "failed", "things": 1, "readings": 1, "at": "string" } ], "readingsList": [ { "seq": 1, "at": "string", "kind": "string", "source": "string", "thingKey": "string", "thingName": "string", "readingId": "string", "label": "string", "state": "ok", "readAt": "string", "was": "ok" } ], "findingsList": [ { "seq": 1, "at": "string", "kind": "string", "thingKey": "string", "thingName": "string", "severity": "high", "what": "string", "from": "reading", "change": "still", "reading": { "id": "string", "label": "string", "state": "ok", "was": "ok", "readAt": "string" }, "incident": { "id": "string", "title": "string", "stage": "string", "words": "string", "waitsOn": "string" }, "raised": { "incidentId": "string", "how": "string" } } ], "fixesList": [ { "incidentId": "string", "title": "string", "thingName": "string", "fixedAt": "string", "action": "string", "before": { "passed": true, "at": "string" }, "after": { "passed": true, "at": "string" }, "undo": { "how": "string", "class": "string" } } ], "ai": { "at": "string", "asked": true, "outcome": "string", "watched": 1 }, "note": "string", "previous": "string", "after": 1, "id": "string", "startedAt": "string", "endedAt": "string", "state": "done", "why": "cadence", "every": "string", "everyMs": 1, "things": 1, "readings": 1, "skipped": 1, "findings": 1, "worst": "high", "bySeverity": { "high": 1, "medium": 1, "low": 1, "critical": 1 }, "fixes": 1, "changed": 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.