Skip to content

Read a kept trace

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

A token that can read is enough.

traceId
required
string

Done.

Media typeapplication/json
object
unprofiled
string
traceId
required
string
keptBecause
required
string
Allowed values: error slow rare new_release raised sampled
path
required
string
spans
required
Array<object>
object
tenantId
required
string
traceId
required
string
spanId
required
string
parentSpanId
required
One of:
string
service
required
string
release
required
One of:
string
name
required
string
kind
required
number
start
required
string
end
required
string
durationMs
required
number
status
required
string
Allowed values: ok error unset
attributes
required
object
key
additional properties
string
criticalPath
required
One of:
object
steps
required
Array<object>
object
spanId
required
string
service
required
string
name
required
string
durationMs
required
number
selfMs
required
number
sentence
required
string
hotspots
required
Array<object>
object
service
required
string
kind
required
string
unit
required
string
total
required
number
frames
required
Array<object>
object
frame
required
string
self
required
number
share
required
number
said
required
string

Example

{  "unprofiled": "string",  "traceId": "string",  "keptBecause": "error",  "path": "string",  "spans": [    {      "tenantId": "string",      "traceId": "string",      "spanId": "string",      "parentSpanId": "string",      "service": "string",      "release": "string",      "name": "string",      "kind": 1,      "start": "string",      "end": "string",      "durationMs": 1,      "status": "ok",      "attributes": {}    }  ],  "criticalPath": {    "steps": [      {        "spanId": "string",        "service": "string",        "name": "string",        "durationMs": 1,        "selfMs": 1      }    ],    "sentence": "string"  },  "hotspots": [    {      "service": "string",      "kind": "string",      "unit": "string",      "total": 1,      "frames": [        {          "frame": "string",          "self": 1,          "share": 1        }      ],      "said": "string"    }  ]}

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.