Skip to content

List metric alerts

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
fingerprint
required
string
entityId
required
string
entityName
required
string
metric
required
string
severity
required
string
impact
required
string
msToImpact
required
One of:
number
sentence
required
string
status
required
string
firstSeenAt
required
string
lastSeenAt
required
string
resolvedAt
required
One of:
string
silentSince
required
One of:
string
timesOpened
required
number
alert
required
string
open
required
number
empty
required
One of:
string

Example

{  "items": [    {      "fingerprint": "string",      "entityId": "string",      "entityName": "string",      "metric": "string",      "severity": "string",      "impact": "string",      "msToImpact": 1,      "sentence": "string",      "status": "string",      "firstSeenAt": "string",      "lastSeenAt": "string",      "resolvedAt": "string",      "silentSince": "string",      "timesOpened": 1,      "alert": "string"    }  ],  "open": 1,  "empty": "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.