Skip to content

Read an incident's review written from its record - its timeline, everyone told and how, the cause and the proof

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
incident
required
object
id
required
string
title
required
string
kind
required
string
severity
required
string
outcome
required
One of:
string
openedAt
required
string
closedAt
required
One of:
string
major
required
object
major
required
boolean
declared
required
One of:
object
at
required
string
by
required
string
reason
required
One of:
string
toDeclareMinutes
required
One of:
number
toResolveMinutes
required
One of:
number
cause
required
One of:
string
proof
required
Array<object>
object
name
required
string
passed
required
boolean
timeline
required
Array<object>
object
at
required
string
type
required
string
data
required
One of:
object
key
additional properties
told
required
Array<object>
object
key
required
string
channel
required
string
Allowed values: push email met slack pagerduty teams telegram discord voice webhook in_app ntfy jsm incident_io rootly apprise sms whatsapp apns fcm
name
required
string
from
required
string
Allowed values: self rule added
cadence
required
One of:
object
every
required
string
Allowed values: change
messages
required
Array<object>
object
stage
required
string
Allowed values: update resolved declared
n
required
number
at
required
string
state
required
string
deliveredAt
required
One of:
string
error
required
One of:
string
ready
required
boolean

Example

{  "incident": {    "id": "string",    "title": "string",    "kind": "string",    "severity": "string",    "outcome": "string",    "openedAt": "string",    "closedAt": "string"  },  "major": {    "major": true,    "declared": {      "at": "string",      "by": "string",      "reason": "string"    }  },  "toDeclareMinutes": 1,  "toResolveMinutes": 1,  "cause": "string",  "proof": [    {      "name": "string",      "passed": true    }  ],  "timeline": [    {      "at": "string",      "type": "string",      "data": {}    }  ],  "told": [    {      "key": "string",      "channel": "push",      "name": "string",      "from": "self",      "cadence": {        "every": "change"      },      "messages": [        {          "stage": "update",          "n": 1,          "at": "string",          "state": "string",          "deliveredAt": "string",          "error": "string"        }      ]    }  ],  "ready": true}

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.