Skip to content

Propose a safe cut to metric and trace volume

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.

POST
/v1/telemetry/diet/propose
curl --request POST \  --url https://api.xovris.ai/v1/telemetry/diet/propose \  --header 'Authorization: Bearer <token>'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Done: something new was made, and the answer is it.

Media typeapplication/json
object
next
required
One of:
string
cuts
required
Array<object>
object
cut
required
One of:
object
kind
required
string
Allowed values: drop_metric
name
required
string
signal
required
string
Allowed values: metrics traces
saves
required
number
words
required
string
refused
required
Array<object>
object
cut
required
One of:
object
kind
required
string
Allowed values: drop_metric
name
required
string
signal
required
string
Allowed values: metrics traces
blockedBy
required
Array<object>
object
reader
required
string
Allowed values: view investigation dashboard alert saved_query
ref
required
string
words
required
string
words
required
string
replayed
required
object
view
required
number
investigation
required
number
dashboard
required
number
alert
required
number
saved_query
required
number
traces
required
number
wouldLoseEvidence
required
number
saved
required
object
metrics
required
object
points
required
number
of
required
number
traces
required
object
traces
required
number
of
required
number
profiles
required
object
saved
required
number
Allowed values: 0
of
required
number
Allowed values: 0
note
required
string
sentence
required
string
id
required
string
window
required
object
since
required
string
until
required
string
state
required
string

Example

{  "next": "string",  "cuts": [    {      "cut": {        "kind": "drop_metric",        "name": "string"      },      "signal": "metrics",      "saves": 1,      "words": "string"    }  ],  "refused": [    {      "cut": {        "kind": "drop_metric",        "name": "string"      },      "signal": "metrics",      "blockedBy": [        {          "reader": "view",          "ref": "string",          "words": "string"        }      ],      "words": "string"    }  ],  "replayed": {    "view": 1,    "investigation": 1,    "dashboard": 1,    "alert": 1,    "saved_query": 1,    "traces": 1  },  "wouldLoseEvidence": 1,  "saved": {    "metrics": {      "points": 1,      "of": 1    },    "traces": {      "traces": 1,      "of": 1    },    "profiles": {      "saved": 0,      "of": 0,      "note": "string"    }  },  "sentence": "string",  "id": "string",  "window": {    "since": "string",    "until": "string"  },  "state": "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.