Skip to content

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.

GET
/v1/reviews/{id}
curl --request GET \  --url https://api.xovris.ai/v1/reviews/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
sources
required
Array<object>
object
id
required
string
state
required
string
Allowed values: failed read withheld
things
required
number
readings
required
number
at
required
string
readingsList
required
Array<object>
object
seq
required
number
at
required
string
kind
required
string
source
required
string
thingKey
required
string
thingName
required
string
readingId
required
string
label
required
string
state
required
string
Allowed values: ok error unread paused attention
readAt
required
One of:
string
was
required
One of:
string
Allowed values: ok error unread paused attention
findingsList
required
Array<object>
object
seq
required
number
at
required
string
kind
required
string
thingKey
required
One of:
string
thingName
required
string
severity
required
string
Allowed values: high medium low critical
what
required
string
from
required
string
Allowed values: reading incident
change
required
string
Allowed values: still new worse
reading
object
id
required
string
label
required
string
state
required
string
Allowed values: ok error unread paused attention
was
required
One of:
string
Allowed values: ok error unread paused attention
readAt
required
One of:
string
incident
object
id
required
string
title
required
string
stage
required
string
words
required
string
waitsOn
required
string
raised
object
incidentId
required
One of:
string
how
required
string
fixesList
required
Array<object>
object
incidentId
required
string
title
required
string
thingName
required
One of:
string
fixedAt
required
One of:
string
action
required
One of:
string
before
required
One of:
object
passed
required
boolean
at
required
string
after
required
One of:
object
passed
required
boolean
at
required
string
undo
required
One of:
object
how
required
string
class
required
string
ai
required
One of:
object
at
required
string
asked
required
boolean
outcome
required
string
watched
required
number
note
required
One of:
string
previous
required
One of:
string
after
required
number
id
required
string
startedAt
required
string
endedAt
required
One of:
string
state
required
string
Allowed values: done failed running
why
required
string
Allowed values: cadence asked
every
required
One of:
string
everyMs
required
One of:
number
things
required
number
readings
required
number
skipped
required
number
findings
required
number
worst
required
One of:
string
Allowed values: high medium low critical
bySeverity
required
object
high
required
number
medium
required
number
low
required
number
critical
required
number
fixes
required
number
changed
required
number

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.

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.