Skip to content

Create an alert rule

POST
/v1/alerts
curl --request POST \
--url https://stats.example.com/v1/alerts \
--header 'Content-Type: application/json' \
--cookie shardlens_session=<shardlens_session> \
--data '{ "name": "example", "metric": "missed_deadline_rate", "comparator": ">", "threshold": 1, "windowS": 1, "webhookUrl": "example" }'

The webhook must be a Discord webhook URL; it is stored encrypted.

Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
metric
required
string
Allowed values: missed_deadline_rate error_rate p95_ms invalid_requests_pct stale_shards interactions_per_min identify_remaining
comparator
required
string
Allowed values: > >= < <=
threshold
required
number
windowS
required
integer
>= 60 <= 86400
webhookUrl
required
string
<= 300 characters

Created

Invalid rule or webhook URL

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}

Needs a Discord sign-in (owner or team) and, for changes, the CSRF header

Media typeapplication/json
object
error
required
string
<= 64 characters
message
string
<= 500 characters
rejected
Array<object>
object
index
required
integer
<= 9007199254740991
reason
required
string
<= 64 characters

Example generated

{
"error": "example",
"message": "example",
"rejected": [
{
"index": 1,
"reason": "example"
}
]
}