Skip to content

Search logs

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

A token that can read is enough.

Done.

Media typeapplication/json
object
first
required
One of:
string
last
required
One of:
string
lines
required
Array<object>
object
id
required
string
at
required
string
sourceAt
required
One of:
string
receivedAt
required
string
level
required
string
Allowed values: error warn info trace fatal debug
severityText
required
string
raisedFrom
required
One of:
string
Allowed values: error warn info trace fatal debug
body
required
string
pattern
required
object
id
required
string
template
required
string
source
required
object
kind
required
string
Allowed values: email check change otlp envelope agent syslog webhook audit access pasted
id
required
string
name
required
string
service
required
One of:
string
host
required
One of:
string
asset
required
One of:
string
observedByXovris
required
boolean
masked
required
number
attributes
required
object
key
additional properties
string
masks
required
object
masked
required
number
fields
required
Array<object>
object
field
required
string
kind
required
string
Allowed values: email phone private_key jwt aws_key github_token slack_token slack_webhook stripe_key google_key model_key xovris_key auth_header url_password secret_value card_number client_ip iban national_id crypto_wallet
count
required
number
words
required
string
sentence
required
One of:
string
links
required
object
changesBefore
required
string
assetStory
string
traceId
required
One of:
string
spanId
required
One of:
string
incidentId
required
One of:
string
changeRunId
required
One of:
string
patterns
required
Array<object>
object
neverSeenBefore
required
boolean
templateId
required
string
template
required
string
count
required
number
errors
required
number
firstSeen
required
string
lastSeen
required
string
lineId
string
incidents
required
Array<object>
object
id
required
string
title
required
string
state
required
string
provenCause
required
One of:
string
answer
required
object
understood
required
string
sentences
required
Array<object>
object
text
required
string
template
string
slots
object
key
additional properties
string
cites
required
Array<object>
object
kind
required
string
Allowed values: incident pattern line change
id
required
string
next
required
One of:
string
query
required
object
pipe
required
string
sql
required
string
facets
object
source
required
Array<object>
object
value
required
string
count
required
number
service
required
Array<object>
object
value
required
string
count
required
number
host
required
Array<object>
object
value
required
string
count
required
number
fields
Array<object>
object
field
required
string
value
required
string
count
required
number
understood
required
string
window
required
object
since
required
string
until
required
string
searchableDays
required
number
total
required
number
bySeverity
required
object
fatal
required
number
error
required
number
warn
required
number
info
required
number
debug
required
number
volume
required
Array<object>
object
from
required
string
count
required
number
error
required
number
warning
required
number
info
required
number
volumeCellSeconds
required
number
changes
object
key
additional properties

Example

{  "first": "string",  "last": "string",  "lines": [    {      "id": "string",      "at": "string",      "sourceAt": "string",      "receivedAt": "string",      "level": "error",      "severityText": "string",      "raisedFrom": "error",      "body": "string",      "pattern": {        "id": "string",        "template": "string"      },      "source": {        "kind": "email",        "id": "string",        "name": "string"      },      "service": "string",      "host": "string",      "asset": "string",      "observedByXovris": true,      "masked": 1,      "attributes": {},      "masks": {        "masked": 1,        "fields": [          {            "field": "string",            "kind": "email",            "count": 1,            "words": "string"          }        ],        "sentence": "string"      },      "links": {        "changesBefore": "string",        "assetStory": "string",        "traceId": "string",        "spanId": "string",        "incidentId": "string",        "changeRunId": "string"      }    }  ],  "patterns": [    {      "neverSeenBefore": true,      "templateId": "string",      "template": "string",      "count": 1,      "errors": 1,      "firstSeen": "string",      "lastSeen": "string",      "lineId": "string"    }  ],  "incidents": [    {      "id": "string",      "title": "string",      "state": "string",      "provenCause": "string"    }  ],  "answer": {    "understood": "string",    "sentences": [      {        "text": "string",        "template": "string",        "slots": {},        "cites": [          {            "kind": "incident",            "id": "string"          }        ]      }    ],    "next": "string"  },  "query": {    "pipe": "string",    "sql": "string"  },  "facets": {    "source": [      {        "value": "string",        "count": 1      }    ],    "service": [      {        "value": "string",        "count": 1      }    ],    "host": [      {        "value": "string",        "count": 1      }    ]  },  "fields": [    {      "field": "string",      "value": "string",      "count": 1    }  ],  "understood": "string",  "window": {    "since": "string",    "until": "string",    "searchableDays": 1  },  "total": 1,  "bySeverity": {    "fatal": 1,    "error": 1,    "warn": 1,    "info": 1,    "debug": 1  },  "volume": [    {      "from": "string",      "count": 1,      "error": 1,      "warning": 1,      "info": 1    }  ],  "volumeCellSeconds": 1,  "changes": {}}

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.