Skip to content

Create alert rule

Requires EDITOR. baselineMode: absolute requires threshold; a relative baseline (day_over_day / week_over_week / both) on conversion_volume requires dropPct. Validation failures return 400.

projectId
required
string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
metric
required
string
Allowed values: conversion_volume report_failure_rate report_dlq_count
baselineMode
string
default: both
Allowed values: day_over_day week_over_week both absolute
dropPct
number | null
<= 1
threshold
number | null
minSample
integer
default: 50
consecutiveTicks
integer
default: 2 >= 1 <= 10
cooldownMinutes
integer
default: 60 >= 5 <= 1440
channels
Array<string>
default:
Allowed values: webhook email
filters
object
key
additional properties
any
notifyOnResolve
boolean
default: true
enabled
boolean
default: true

Created rule.

Media typeapplication/json
object
rule
object
key
additional properties
any

Param validation failed, or baseline/metric-specific field missing.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}