Skip to content

Compare a window of logs with its healthy baseline

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

A token that can read is enough.

Done.

Media typeapplication/json
object
fields
required
One of:
Array<object>
object
field
required
string
value
required
string
now
required
number
then
required
number
errorsNow
required
number
shareNow
required
number
shareThen
required
number
rate
required
object
linesTimes
required
One of:
number
errorsTimes
required
One of:
number
linesNow
required
One of:
number
errorsNow
required
One of:
number
linesThen
required
One of:
number
errorsThen
required
One of:
number
shareFixed
required
boolean
failing
required
object
since
required
string
until
required
string
lengthMs
required
number
lines
required
number
errors
required
number
errorShare
required
One of:
number
healthy
required
One of:
object
label
required
string
kind
required
One of:
string
Allowed values: asked before week yesterday
backMs
required
One of:
number
lengthMs
required
number
since
required
string
until
required
string
lines
required
number
errors
required
number
errorShare
required
One of:
number
why
required
string
learnedFrom
required
number
newKinds
required
Array<object>
object
templateId
required
string
template
required
string
now
required
number
then
required
number
low
number
high
number
history
number
rose
required
Array<object>
object
templateId
required
string
template
required
string
now
required
number
then
required
number
low
number
high
number
history
number
fell
required
Array<object>
object
templateId
required
string
template
required
string
now
required
number
then
required
number
low
number
high
number
history
number
stopped
required
Array<object>
object
templateId
required
string
template
required
string
now
required
number
then
required
number
low
number
high
number
history
number
totals
required
object
newKinds
required
number
rose
required
number
fell
required
number
stopped
required
number
patterns
required
Array<object>
object
templateId
required
string
template
required
string
now
required
number
errors
required
number
expected
required
number
low
required
number
high
required
number
history
required
number
sufficient
required
boolean
status
required
string
Allowed values: normal above below new stopped
considered
required
Array<object>
object
label
required
string
kind
required
One of:
string
Allowed values: asked before week yesterday
backMs
required
One of:
number
since
required
string
until
required
string
healthy
required
boolean
why
required
string
code
required
string
Allowed values: length incidents errors healthy invalid no-lines overlaps
incidents
required
number
errorShare
required
One of:
number
searched
required
object
windows
required
number
from
required
One of:
string
until
required
One of:
string
sentence
required
string
understood
required
string

Example

{  "fields": [    {      "field": "string",      "value": "string",      "now": 1,      "then": 1,      "errorsNow": 1,      "shareNow": 1,      "shareThen": 1    }  ],  "rate": {    "linesTimes": 1,    "errorsTimes": 1,    "linesNow": 1,    "errorsNow": 1,    "linesThen": 1,    "errorsThen": 1  },  "shareFixed": true,  "failing": {    "since": "string",    "until": "string",    "lengthMs": 1,    "lines": 1,    "errors": 1,    "errorShare": 1  },  "healthy": {    "label": "string",    "kind": "asked",    "backMs": 1,    "lengthMs": 1,    "since": "string",    "until": "string",    "lines": 1,    "errors": 1,    "errorShare": 1,    "why": "string",    "learnedFrom": 1  },  "newKinds": [    {      "templateId": "string",      "template": "string",      "now": 1,      "then": 1,      "low": 1,      "high": 1,      "history": 1    }  ],  "rose": [    {      "templateId": "string",      "template": "string",      "now": 1,      "then": 1,      "low": 1,      "high": 1,      "history": 1    }  ],  "fell": [    {      "templateId": "string",      "template": "string",      "now": 1,      "then": 1,      "low": 1,      "high": 1,      "history": 1    }  ],  "stopped": [    {      "templateId": "string",      "template": "string",      "now": 1,      "then": 1,      "low": 1,      "high": 1,      "history": 1    }  ],  "totals": {    "newKinds": 1,    "rose": 1,    "fell": 1,    "stopped": 1  },  "patterns": [    {      "templateId": "string",      "template": "string",      "now": 1,      "errors": 1,      "expected": 1,      "low": 1,      "high": 1,      "history": 1,      "sufficient": true,      "status": "normal"    }  ],  "considered": [    {      "label": "string",      "kind": "asked",      "backMs": 1,      "since": "string",      "until": "string",      "healthy": true,      "why": "string",      "code": "length",      "incidents": 1,      "errorShare": 1    }  ],  "searched": {    "windows": 1,    "from": "string",    "until": "string"  },  "sentence": "string",  "understood": "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.