Skip to content

Read an incident

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
history
required
Array<object>
object
at
required
One of:
string
state
required
string
Allowed values: up down
from
required
One of:
string
runId
required
string
ms
required
One of:
number
phase
required
One of:
string
error
required
One of:
object
code
required
string
message
required
string
status
required
One of:
number
place
required
One of:
string
historyBegins
required
null
named
required
One of:
object
words
required
string
area
required
string
at
required
string
times
required
object
detected
required
One of:
string
causeConcluded
required
One of:
string
fixReady
required
One of:
string
approved
required
One of:
string
changeStarted
required
One of:
string
changed
required
One of:
string
proved
required
One of:
string
putBack
required
One of:
string
ruledOut
required
Array<object>
object
cause
required
string
check
required
string
found
required
string
at
required
One of:
string
trail
required
Array<object>
object
n
required
number
kind
required
string
Allowed values: check conclusion theory
check
required
string
about
required
One of:
string
read
required
One of:
string
found
required
One of:
string
outcome
required
One of:
string
Allowed values: unavailable refutes inconclusive supports
startedAt
required
One of:
string
at
required
One of:
string
ms
required
One of:
number
findings
required
object
firstFinding
required
One of:
object
at
required
string
step
required
number
check
required
string
outcome
required
string
Allowed values: refutes supports
timeToFirstFindingMs
required
One of:
number
timeToCauseMs
required
One of:
number
path
required
One of:
object
hops
required
Array<object>
object
id
required
string
label
required
string
state
required
string
Allowed values: unread broken healthy
checks
required
Array<string>
found
required
One of:
string
breaksAt
required
One of:
string
from
required
string
Allowed values: records checks
triage
required
object
snoozed
required
One of:
object
until
required
One of:
string
untilWorse
required
boolean
untilActivity
required
boolean
by
required
string
at
required
string
words
required
string
woke
required
One of:
object
at
required
One of:
string
because
required
string
Allowed values: person time worse activity
words
required
string
muted
required
One of:
object
until
required
string
by
required
string
at
required
string
words
required
string
mergedInto
required
One of:
object
id
required
string
by
required
string
at
required
string
mergedFrom
required
Array<string>
owner
required
One of:
string
watchers
required
Array<string>
acked
required
One of:
object
by
required
string
at
required
string
from
required
string
Allowed values: push email phone app slack teams centre toast
words
required
string
pinnedBy
required
Array<string>
stage
required
object
id
required
string
Allowed values: fixed investigating needs_you fixing fix_ready put_back closed_unproven proving restored_unproven cause_found
words
required
string
waitsOn
required
string
Allowed values: xovris you nobody
cause
required
string
Allowed values: none confirmed likely
proven
required
string
Allowed values: fix nothing cause
approve
required
One of:
string
press
required
One of:
object
kind
required
string
Allowed values: approve choose access
label
required
string
left
required
string
seenBy
Array<object>
object
name
required
string
target
required
One of:
string
alertId
required
string
checkId
required
One of:
string
checkKind
required
One of:
string
status
required
string
Allowed values: firing resolved
firstSeen
required
string
answeredAt
required
One of:
string
headline
required
string
why
required
One of:
string
id
required
kind
required
kindId
required
string
Allowed values: email domain api website ai server phone logs status_page people security cloud code family payment account app storage system network backup computer traces monitoring database job smart_home peripheral messaging work_tools customers
title
required
severity
required
state
required
outcome
required
statusLine
required
string
assetRef
required
release
required
openedAt
required
One of:
string
closedAt
required
One of:
string
fixedBy
required
One of:
object
at
required
string
medianMinutes
required
number
percentile
required
number
Allowed values: 80
of
required
number
slipped
required
boolean
words
required
string
timeline
required
Array<object>
object
seq
required
type
required
actor
required
object
kind
required
id
required
at
required
One of:
string
data
required
cause
required
One of:
object
headline
required
string
proof
required
string
Allowed values: confirmed likely
by
required
string
Allowed values: records checks
faultClass
required
One of:
string
causeCheck
required
One of:
object
verdict
required
string
Allowed values: confirmed not_entitled vetoed deterministic_only
by
required
One of:
string
model
required
One of:
string
reason
required
string
at
required
One of:
string
severityRecord
required
object
severity
required
string
Allowed values: high medium low critical
rated
required
number
changed
required
number
lower
required
number
evidence
required
Array<object>
object
deletedAt
One of:
string
deleted
string
id
required
kind
required
label
required
string
sourceKind
required
sourceRef
required
query
required
observedAt
required
One of:
string
producedByStep
required
content
required
investigation
required
One of:
object
status
required
narrativeStatus
required
narrative
required
One of:
string
narrativeMark
required
One of:
object
aiGenerated
required
boolean
generator
required
string
Allowed values: Xovris
label
required
string
conclusion
required
One of:
object
status
One of:
string
hypothesisId
One of:
string
decidingDiagnosticRunId
One of:
string
summary
One of:
string
headline
One of:
string
uncertainty
Array<string>
wouldDetermine
Array<string>
key
additional properties
modelSpendUsd
required
string
repairs
required
Array<object>
object
risk
required
One of:
object
level
required
string
Allowed values: high medium low
line
required
string
id
required
incidentId
required
actionId
required
actionVersion
required
title
required
string
proof
required
object
tests
required
Array<object>
object
phase
required
seq
required
passed
required
digest
required
at
required
ledger
required
object
seq
required
number
chainHash
required
string
verdicts
required
Array<object>
object
kind
required
passed
required
by
required
digest
required
at
required
ledger
required
object
seq
required
number
chainHash
required
string
receipt
required
One of:
object
outcome
required
ledger
required
object
seq
required
number
chainHash
required
string
verify
required
string
humanDescription
required
One of:
object
changes
required
string
where
required
string
undo
required
string
check
required
string
state
required
outcome
required
revisions
required
Array<object>
object
seq
required
request
required
at
required
One of:
string
before
required
after
required
applied
required
boolean
understood
required
Array<string>
notUnderstood
required
revisable
required
boolean
statusLine
required
One of:
string
transitions
required
Array<object>
object
seq
required
from
required
to
required
reason
required
at
required
One of:
string
steps
required
Array<object>
object
stepId
required
phase
required
attempts
required
updatedAt
required
One of:
string
record
required
Array<object>
object
seq
required
number
at
required
string
kind
required
string
Allowed values: state read decision proof change
title
required
string
state
object
from
required
string
to
required
string
step
object
id
required
string
phase
required
string
attempts
required
number
read
Array<object>
object
what
required
string
source
required
One of:
string
detail
required
One of:
string
changed
One of:
object
before
required
One of:
object
key
additional properties
after
required
One of:
object
key
additional properties
proved
One of:
object
what
required
string
by
One of:
string
passed
required
One of:
boolean
digest
required
One of:
string
ledgerSeq
required
One of:
number
chainHash
required
One of:
string
undo
One of:
object
state
required
string
Allowed values: taken_back by_hand exact compensate cannot
how
required
One of:
string
bySeq
required
One of:
number
steps
Array<string>
press
One of:
object
seq
required
number
undoes
One of:
number
verification
required
Array
left
required
One of:
string
before
required
object
key
additional properties
after
required
object
key
additional properties
restored
required
One of:
object
equal
required
boolean
readAt
required
One of:
string
fields
required
number
beforeDigest
required
string
afterDigest
required
string
zone
required
One of:
string
name
required
One of:
string
blockedBy
required
null
approval
required
One of:
object
packageDigest
required
string
packageVersion
required
One of:
number
awaitingSince
required
One of:
string
rehearsal
required
One of:
object
key
additional properties
oneTap
required
object
method
required
string
path
required
string
body
required
object
packageDigest
required
string
change
required
One of:
object
kind
required
string
kindId
required
One of:
string
thing
required
string
before
required
Array<object>
object
field
required
string
value
required
string
after
required
Array<object>
object
field
required
string
value
required
string
written
required
boolean
reach
required
One of:
object
touched
required
Array<object>
object
name
required
string
untouched
required
number
of
required
string
words
required
string
rehearsed
required
One of:
object
safe
required
boolean
checks
required
number
wayBack
required
One of:
object
reversibility
required
string
how
required
One of:
string
restores
required
Array<object>
object
field
required
string
value
required
string
steps
required
Array<string>
afterTest
required
Array<object>
object
id
required
string
name
required
string
from
required
One of:
string
state
required
string
Allowed values: failed planned passed running
at
required
One of:
string
detail
required
One of:
string
before
required
One of:
object
state
required
string
Allowed values: failed passed
detail
required
One of:
string
at
required
One of:
string
price
object
unit
required
string
basis
required
string
Allowed values: included per_fix being_priced
points
required
object
GBP
required
One of:
number
EUR
required
One of:
number
USD
required
One of:
number
used
required
number
allowance
required
One of:
number
words
required
string
receipts
required
Array<object>
object
id
required
runId
required
outcome
required
statusLine
required
body
required
createdAt
required
One of:
string
sources
required
Array<object>
object
url
required
title
required
One of:
object
kind
required
fetchedAt
required
One of:
string
provider
required
One of:
string
block
required
One of:
object
kind
required
string
Allowed values: consent third_party safety law
says
required
string
wouldRemove
required
string
pastCases
required
One of:
object
matches
required
Array<object>
object
rank
required
number
tier
required
number
reason
required
string
layer
required
string
Allowed values: yours global
action
required
string
thisFixSeconds
required
One of:
number
firstTimeMedianSeconds
required
One of:
number
savedSeconds
required
One of:
number
words
required
string
library
required
One of:
object
verifiedMatches
required
number
notHeld
required
number
use
required
One of:
string
Allowed values: reused adapted different
fixed
required
boolean
proof
required
One of:
object
before
required
One of:
object
passed
required
boolean
digest
required
string
at
required
string
after
required
One of:
object
passed
required
boolean
digest
required
string
at
required
string
proven
required
boolean
contributed
required
One of:
object
faultClass
required
string
action
required
string
at
required
string
memoryPaused
required
boolean
statement
required
string
words
required
string
timeAndMoneySaved
required
object
measured
required
boolean
thisSeconds
required
One of:
number
yardstickSeconds
required
One of:
number
against
required
One of:
string
Allowed values: first_time_fixes earlier_same_kind
of
required
number
savedSeconds
required
One of:
number
money
required
One of:
object
amountMinor
required
number
currency
required
string
rate
required
object
what
required
string
source
required
string
url
required
string
read
required
string
amountMinor
required
number
currency
required
string
words
required
string
explanation
required
One of:
object
faultClass
required
string
words
required
string
locale
required
string
translated
required
boolean
payment
required
One of:
object
amountMinor
required
number
currency
required
string
payee
required
string
reason
required
string
deadline
required
string
url
required
string
kind
required
string
Allowed values: licence domain_renewal paid_certificate provider_tier
subject
required
string
then
required
string
priceSource
required
object
url
required
string
readAt
required
string
openedAt
required
string
tickets
required
Array<object>
object
tool
required
key
required
url
required
One of:
object
lastPushed
required
One of:
object
linkedAt
required
One of:
string
xos
required
object
xos
required
number
Allowed values: 1
kind
required
string
Allowed values: page report fix change answer alert tile
received_at
required
string
verdict
required
object
state
required
string
Allowed values: unknown fixed stale broken healthy working needs_you at_risk
text
required
string
targets
required
Array<object>
object
type
required
string
Allowed values: email domain dns website security cloud code device app network identity
id
required
string
claims
required
Array<object>
object
id
required
string
text
required
string
support
required
string
Allowed values: verified contradicted unchecked
evidence
required
Array<string>
evidence
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: query video log diff measurement trace screenshot citation
source
required
string
captured_at
required
string
ttl_s
required
number
rerun
required
string
sha256
string
excerpt
string
checked
string
found
string
outcome
string
Allowed values: refutes inconclusive supports
confidence
required
object
tier
required
string
Allowed values: high medium low
reasons
required
Array<string>
would_raise
required
Array<string>
alternatives
required
Array<object>
object
cause
required
string
status
required
string
Allowed values: confirmed ruled_out possible
evidence
required
Array<string>
record
One of:
object
right
required
number
n
required
number
lower
required
number
plan
required
Array<object>
object
step
required
string
status
required
string
Allowed values: done failed active pending skipped
actions
required
Array<object>
object
id
required
string
label
required
string
consequence
required
string
reach
required
Array<string>
reversible
required
string
Allowed values: yes partly no
undo
required
One of:
object
method
required
string
window
required
string
cost
required
string
permission
required
string
Allowed values: ask auto deny
explains
object
changes
required
string
where
string
undo
string
primary
boolean
href
string
proof
required
One of:
object
before
required
object
metric
required
string
value
required
string
after
required
object
metric
required
string
value
required
string
method
required
string
verified_at
required
string
replay
string
verification
required
One of:
object
state
required
string
Allowed values: verified reverted unverified
check
required
string
output
string
why
string
at
required
string
undo_receipt
required
One of:
object
checkpoint
required
string
at
required
string
covers
required
Array<string>
does_not_cover
required
Array<string>
timeline
required
Array<object>
object
t
required
string
type
required
string
Allowed values: error result action needs_you thought
text
required
string
body
required
Array<object>
object
id
required
string
Allowed values: changed why found left checked
text
required
string
changes
required
Array<object>
object
group
required
string
explanation
required
string
target
required
string
rows
required
Array<object>
object
before
required
One of:
string
after
required
One of:
string
moved
boolean
impact
string
status
string
agent
required
string
Allowed values: Xovris

Example

{  "history": [    {      "at": "string",      "state": "up",      "from": "string",      "runId": "string",      "ms": 1,      "phase": "string",      "error": {        "code": "string",        "message": "string"      },      "status": 1,      "place": "string"    }  ],  "historyBegins": null,  "named": {    "words": "string",    "area": "string",    "at": "string"  },  "times": {    "detected": "string",    "causeConcluded": "string",    "fixReady": "string",    "approved": "string",    "changeStarted": "string",    "changed": "string",    "proved": "string",    "putBack": "string"  },  "ruledOut": [    {      "cause": "string",      "check": "string",      "found": "string",      "at": "string"    }  ],  "trail": [    {      "n": 1,      "kind": "check",      "check": "string",      "about": "string",      "read": "string",      "found": "string",      "outcome": "unavailable",      "startedAt": "string",      "at": "string",      "ms": 1    }  ],  "findings": {    "firstFinding": {      "at": "string",      "step": 1,      "check": "string",      "outcome": "refutes"    },    "timeToFirstFindingMs": 1,    "timeToCauseMs": 1  },  "path": {    "hops": [      {        "id": "string",        "label": "string",        "state": "unread",        "checks": [          "string"        ],        "found": "string"      }    ],    "breaksAt": "string",    "from": "records"  },  "triage": {    "snoozed": {      "until": "string",      "untilWorse": true,      "untilActivity": true,      "by": "string",      "at": "string",      "words": "string"    },    "woke": {      "at": "string",      "because": "person",      "words": "string"    },    "muted": {      "until": "string",      "by": "string",      "at": "string",      "words": "string"    },    "mergedInto": {      "id": "string",      "by": "string",      "at": "string"    },    "mergedFrom": [      "string"    ],    "owner": "string",    "watchers": [      "string"    ],    "acked": {      "by": "string",      "at": "string",      "from": "push",      "words": "string"    },    "pinnedBy": [      "string"    ]  },  "stage": {    "id": "fixed",    "words": "string",    "waitsOn": "xovris",    "cause": "none",    "proven": "fix",    "approve": "string",    "press": {      "kind": "approve",      "label": "string"    },    "left": "string"  },  "seenBy": [    {      "name": "string",      "target": "string",      "alertId": "string",      "checkId": "string",      "checkKind": "string",      "status": "firing",      "firstSeen": "string",      "answeredAt": "string",      "headline": "string",      "why": "string"    }  ],  "id": null,  "kind": null,  "kindId": "email",  "title": null,  "severity": null,  "state": null,  "outcome": null,  "statusLine": "string",  "assetRef": null,  "release": null,  "openedAt": "string",  "closedAt": "string",  "fixedBy": {    "at": "string",    "medianMinutes": 1,    "percentile": 80,    "of": 1,    "slipped": true,    "words": "string"  },  "timeline": [    {      "seq": null,      "type": null,      "actor": {        "kind": null,        "id": null      },      "at": "string",      "data": null    }  ],  "cause": {    "headline": "string",    "proof": "confirmed",    "by": "records",    "faultClass": "string"  },  "causeCheck": {    "verdict": "confirmed",    "by": "string",    "model": "string",    "reason": "string",    "at": "string"  },  "severityRecord": {    "severity": "high",    "rated": 1,    "changed": 1,    "lower": 1  },  "evidence": [    {      "deletedAt": "string",      "deleted": "string",      "id": null,      "kind": null,      "label": "string",      "sourceKind": null,      "sourceRef": null,      "query": null,      "observedAt": "string",      "producedByStep": null,      "content": null    }  ],  "investigation": {    "status": null,    "narrativeStatus": null,    "narrative": "string",    "narrativeMark": {      "aiGenerated": true,      "generator": "Xovris",      "label": "string"    },    "conclusion": {      "status": "string",      "hypothesisId": "string",      "decidingDiagnosticRunId": "string",      "summary": "string",      "headline": "string",      "uncertainty": [        "string"      ],      "wouldDetermine": [        "string"      ]    },    "modelSpendUsd": "string"  },  "repairs": [    {      "risk": {        "level": "high",        "line": "string"      },      "id": null,      "incidentId": null,      "actionId": null,      "actionVersion": null,      "title": "string",      "proof": {        "tests": [          {            "phase": null,            "seq": null,            "passed": null,            "digest": null,            "at": null,            "ledger": {              "seq": 1,              "chainHash": "string"            }          }        ],        "verdicts": [          {            "kind": null,            "passed": null,            "by": null,            "digest": null,            "at": null,            "ledger": {              "seq": 1,              "chainHash": "string"            }          }        ],        "receipt": {          "outcome": null,          "ledger": {            "seq": 1,            "chainHash": "string"          }        },        "verify": "string"      },      "humanDescription": {        "changes": "string",        "where": "string",        "undo": "string",        "check": "string"      },      "state": null,      "outcome": null,      "revisions": [        {          "seq": null,          "request": null,          "at": "string",          "before": null,          "after": null,          "applied": true,          "understood": [            "string"          ],          "notUnderstood": null        }      ],      "revisable": true,      "statusLine": "string",      "transitions": [        {          "seq": null,          "from": null,          "to": null,          "reason": null,          "at": "string"        }      ],      "steps": [        {          "stepId": null,          "phase": null,          "attempts": null,          "updatedAt": "string"        }      ],      "record": [        {          "seq": 1,          "at": "string",          "kind": "state",          "title": "string",          "state": {            "from": "string",            "to": "string"          },          "step": {            "id": "string",            "phase": "string",            "attempts": 1          },          "read": [            {              "what": "string",              "source": "string",              "detail": "string"            }          ],          "changed": {            "before": {},            "after": {}          },          "proved": {            "what": "string",            "by": "string",            "passed": true,            "digest": "string",            "ledgerSeq": 1,            "chainHash": "string"          },          "undo": {            "state": "taken_back",            "how": "string",            "bySeq": 1,            "steps": [              "string"            ],            "press": {              "seq": null            }          },          "undoes": 1        }      ],      "verification": [        null      ],      "left": "string",      "before": {},      "after": {},      "restored": {        "equal": true,        "readAt": "string",        "fields": 1,        "beforeDigest": "string",        "afterDigest": "string",        "zone": "string",        "name": "string"      },      "blockedBy": null,      "approval": {        "packageDigest": "string",        "packageVersion": 1,        "awaitingSince": "string",        "rehearsal": {},        "oneTap": {          "method": "string",          "path": "string",          "body": {            "packageDigest": "string"          }        }      },      "change": {        "kind": "string",        "kindId": "string",        "thing": "string",        "before": [          {            "field": "string",            "value": "string"          }        ],        "after": [          {            "field": "string",            "value": "string"          }        ],        "written": true      },      "reach": {        "touched": [          {            "name": "string"          }        ],        "untouched": 1,        "of": "string",        "words": "string",        "rehearsed": {          "safe": true,          "checks": 1        }      },      "wayBack": {        "reversibility": "string",        "how": "string",        "restores": [          {            "field": "string",            "value": "string"          }        ],        "steps": [          "string"        ]      },      "afterTest": [        {          "id": "string",          "name": "string",          "from": "string",          "state": "failed",          "at": "string",          "detail": "string",          "before": {            "state": "failed",            "detail": "string",            "at": "string"          }        }      ],      "price": {        "unit": "string",        "basis": "included",        "points": {          "GBP": 1,          "EUR": 1,          "USD": 1        },        "used": 1,        "allowance": 1,        "words": "string"      }    }  ],  "receipts": [    {      "id": null,      "runId": null,      "outcome": null,      "statusLine": null,      "body": null,      "createdAt": "string"    }  ],  "sources": [    {      "url": null,      "title": {},      "kind": null,      "fetchedAt": "string",      "provider": "string"    }  ],  "block": {    "kind": "consent",    "says": "string",    "wouldRemove": "string"  },  "pastCases": {    "matches": [      {        "rank": 1,        "tier": 1,        "reason": "string",        "layer": "yours",        "action": "string"      }    ],    "thisFixSeconds": 1,    "firstTimeMedianSeconds": 1,    "savedSeconds": 1,    "words": "string",    "library": {      "verifiedMatches": 1,      "notHeld": 1,      "use": "reused",      "fixed": true,      "proof": {        "before": {          "passed": null,          "digest": null,          "at": null        },        "after": {          "passed": null,          "digest": null,          "at": null        },        "proven": true      },      "contributed": {        "faultClass": "string",        "action": "string",        "at": "string"      },      "memoryPaused": true,      "statement": "string",      "words": "string"    }  },  "timeAndMoneySaved": {    "measured": true,    "thisSeconds": 1,    "yardstickSeconds": 1,    "against": "first_time_fixes",    "of": 1,    "savedSeconds": 1,    "money": {      "amountMinor": 1,      "currency": "string",      "rate": {        "what": "string",        "source": "string",        "url": "string",        "read": "string",        "amountMinor": 1,        "currency": "string"      }    },    "words": "string"  },  "explanation": {    "faultClass": "string",    "words": "string",    "locale": "string",    "translated": true  },  "payment": {    "amountMinor": 1,    "currency": "string",    "payee": "string",    "reason": "string",    "deadline": "string",    "url": "string",    "kind": "licence",    "subject": "string",    "then": "string",    "priceSource": {      "url": "string",      "readAt": "string"    },    "openedAt": "string"  },  "tickets": [    {      "tool": null,      "key": null,      "url": {},      "lastPushed": {},      "linkedAt": "string"    }  ],  "xos": {    "xos": 1,    "kind": "page",    "received_at": "string",    "verdict": {      "state": "unknown",      "text": "string"    },    "targets": [      {        "type": "email",        "id": "string"      }    ],    "claims": [      {        "id": "string",        "text": "string",        "support": "verified",        "evidence": [          "string"        ]      }    ],    "evidence": [      {        "id": "string",        "kind": "query",        "source": "string",        "captured_at": "string",        "ttl_s": 1,        "rerun": "string",        "sha256": "string",        "excerpt": "string",        "checked": "string",        "found": "string",        "outcome": "refutes"      }    ],    "confidence": {      "tier": "high",      "reasons": [        "string"      ],      "would_raise": [        "string"      ],      "alternatives": [        {          "cause": "string",          "status": "confirmed",          "evidence": [            "string"          ]        }      ],      "record": {        "right": 1,        "n": 1,        "lower": 1      }    },    "plan": [      {        "step": "string",        "status": "done"      }    ],    "actions": [      {        "id": "string",        "label": "string",        "consequence": "string",        "reach": [          "string"        ],        "reversible": "yes",        "undo": {          "method": "string",          "window": "string"        },        "cost": "string",        "permission": "ask",        "explains": {          "changes": "string",          "where": "string",          "undo": "string"        },        "primary": true,        "href": "string"      }    ],    "proof": {      "before": {        "metric": "string",        "value": "string"      },      "after": {        "metric": "string",        "value": "string"      },      "method": "string",      "verified_at": "string",      "replay": "string"    },    "verification": {      "state": "verified",      "check": "string",      "output": "string",      "why": "string",      "at": "string"    },    "undo_receipt": {      "checkpoint": "string",      "at": "string",      "covers": [        "string"      ],      "does_not_cover": [        "string"      ]    },    "timeline": [      {        "t": "string",        "type": "error",        "text": "string"      }    ],    "body": [      {        "id": "changed",        "text": "string"      }    ],    "changes": [      {        "group": "string",        "explanation": "string",        "target": "string",        "rows": [          {            "before": "string",            "after": "string",            "moved": true          }        ]      }    ],    "impact": "string",    "status": "string",    "agent": "Xovris"  }}

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.