Skip to content

Read an error

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
messages
required
object
read
required
number
templates
required
Array<object>
object
templateId
required
string
template
required
string
events
required
number
lastSeen
required
string
tags
required
object
read
required
number
keys
required
Array<object>
object
key
required
string
total
required
number
values
required
Array<object>
object
value
required
string
count
required
number
elsewhere
number
kind
required
string
Allowed values: custom other client application
baseline
object
read
required
number
apart
required
Array<object>
object
key
required
string
value
required
string
here
required
number
elsewhere
required
number
page
required
number
scope
required
object
events
required
number
unhandled
required
number
environments
required
Array<object>
object
name
required
string
events
required
number
firstSeen
required
One of:
string
lastSeen
required
One of:
string
environment
required
One of:
string
period
required
One of:
string
from
required
One of:
string
to
required
One of:
string
feedback
required
Array<object>
object
eventId
required
string
session
required
One of:
string
id
required
string
name
required
One of:
string
email
required
One of:
string
message
required
string
url
required
One of:
string
at
required
string
latestLateMaps
number
lineage
required
One of:
object
release
required
One of:
object
version
required
string
commitSha
required
One of:
string
deployedAt
required
string
introducedBy
required
Array<object>
object
sha
required
string
author
required
One of:
string
agent
One of:
string
at
required
One of:
string
files
Array<string>
subject
string
lines
required
Array<object>
object
frame
required
object
file
required
string
line
required
number
fn
string
inApp
boolean
sha
required
string
author
required
string
at
required
One of:
string
summary
string
inRelease
required
boolean
unread
required
Array<string>
base
required
One of:
object
version
required
string
deployedAt
required
string
events
required
number
ranHours
required
number
broughtInByDeploy
required
One of:
boolean
latestEvent
required
One of:
object
key
additional properties
latestEventId
required
One of:
string
projectName
required
One of:
string
hours
required
One of:
Array
life
required
One of:
object
from
required
string
stepMinutes
required
number
counts
required
Array<number>
fix
required
One of:
object
state
required
string
Allowed values: none held reverted returned not_fixed tracing not_an_error not_placed not_opened fix_opened shipped
incidentId
required
One of:
string
at
required
One of:
string
repository
required
One of:
string
line
required
One of:
string
approach
required
One of:
string
pullRequest
required
One of:
object
url
required
One of:
string
branch
required
One of:
string
release
required
One of:
string
since
required
One of:
number
final
required
boolean
files
required
Array<string>
source
required
One of:
object
file
required
string
line
required
number
from
required
number
lines
required
Array<string>
rev
required
One of:
string
id
required
projectId
required
title
required
culprit
required
level
required
status
required
firstSeen
required
One of:
string
lastSeen
required
One of:
string
eventCount
required
number
storedCount
required
number
droppedCount
required
number
unhandledCount
required
number
affectedUsers
required
number
affectedUsersUpTo
required
number
affectedUsersCounted
required
boolean
groupingVersion
required
fingerprintBasis
required
regressedInRelease
required
resolvedInRelease
required
One of:
object
grouping
required
object
version
required
number
basis
required
string
corpus
required
One of:
string
Allowed values: stackless per-stack
cases
required
number
precision
required
One of:
number
recall
required
One of:
number
groupingAccuracy
required
One of:
number
splits
required
number
merges
required
number
said
required
string
openedBy
required
string
Allowed values: person events
assigneeId
required
One of:
string
priority
required
object
value
required
string
Allowed values: high medium low
set
required
boolean
releases
required
Array<object>
object
release
required
firstSeen
required
One of:
string
eventCount
required
number
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

{  "messages": {    "read": 1,    "templates": [      {        "templateId": "string",        "template": "string",        "events": 1,        "lastSeen": "string"      }    ]  },  "tags": {    "read": 1,    "keys": [      {        "key": "string",        "total": 1,        "values": [          {            "value": "string",            "count": 1,            "elsewhere": 1          }        ],        "kind": "custom"      }    ],    "baseline": {      "read": 1    },    "apart": [      {        "key": "string",        "value": "string",        "here": 1,        "elsewhere": 1      }    ],    "page": 1  },  "scope": {    "events": 1,    "unhandled": 1,    "environments": [      {        "name": "string",        "events": 1      }    ],    "firstSeen": "string",    "lastSeen": "string",    "environment": "string",    "period": "string",    "from": "string",    "to": "string"  },  "feedback": [    {      "eventId": "string",      "session": "string",      "id": "string",      "name": "string",      "email": "string",      "message": "string",      "url": "string",      "at": "string"    }  ],  "latestLateMaps": 1,  "lineage": {    "release": {      "version": "string",      "commitSha": "string",      "deployedAt": "string"    },    "introducedBy": [      {        "sha": "string",        "author": "string",        "agent": "string",        "at": "string",        "files": [          "string"        ],        "subject": "string"      }    ],    "lines": [      {        "frame": {          "file": "string",          "line": 1,          "fn": "string",          "inApp": true        },        "sha": "string",        "author": "string",        "at": "string",        "summary": "string",        "inRelease": true      }    ],    "unread": [      "string"    ],    "base": {      "version": "string",      "deployedAt": "string",      "events": 1,      "ranHours": 1    },    "broughtInByDeploy": true  },  "latestEvent": {},  "latestEventId": "string",  "projectName": "string",  "hours": [    1  ],  "life": {    "from": "string",    "stepMinutes": 1,    "counts": [      1    ]  },  "fix": {    "state": "none",    "incidentId": "string",    "at": "string",    "repository": "string",    "line": "string",    "approach": "string",    "pullRequest": {      "url": "string",      "branch": "string"    },    "release": "string",    "since": 1,    "final": true,    "files": [      "string"    ],    "source": {      "file": "string",      "line": 1,      "from": 1,      "lines": [        "string"      ],      "rev": "string"    }  },  "id": null,  "projectId": null,  "title": null,  "culprit": null,  "level": null,  "status": null,  "firstSeen": "string",  "lastSeen": "string",  "eventCount": 1,  "storedCount": 1,  "droppedCount": 1,  "unhandledCount": 1,  "affectedUsers": 1,  "affectedUsersUpTo": 1,  "affectedUsersCounted": true,  "groupingVersion": null,  "fingerprintBasis": null,  "regressedInRelease": null,  "resolvedInRelease": {},  "grouping": {    "version": 1,    "basis": "string",    "corpus": "stackless",    "cases": 1,    "precision": 1,    "recall": 1,    "groupingAccuracy": 1,    "splits": 1,    "merges": 1,    "said": "string"  },  "openedBy": "person",  "assigneeId": "string",  "priority": {    "value": "high",    "set": true  },  "releases": [    {      "release": null,      "firstSeen": "string",      "eventCount": 1    }  ],  "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.