API: Alerts

Threshold alert rules on dashboards and metrics. All endpoints require authentication unless noted. 9 endpoints.

GET /api/dashboard-alerts

List alerts visible to the caller

Responses: 200 · 400 · 401

POST /api/dashboard-alerts

Create a dashboard alert

Request body (JSON)

Field	Type	Required	Description
name	string	yes
description	string	no
condition	object	yes
channels	object	no
scheduleCron	string	no

Responses: 201 · 400 · 401 · 409

PUT /api/dashboard-alerts/{id}

Update an alert

Path parameters

Name	Type	Required	Description
id	string	yes

Request body (JSON)

Field	Type	Required	Description
name	string	no
description	string	no
condition	object	no
channels	object	no
isActive	boolean	no
scheduleCron	string	no

Responses: 200 · 400 · 401 · 404

DELETE /api/dashboard-alerts/{id}

Delete an alert

Path parameters

Name	Type	Required	Description
id	string	yes

Responses: 204 — No content · 401 · 404

PUT /api/dashboard-alerts/{id}/snooze

Snooze an alert for the caller until a time (no push or email to them; the alert keeps firing for others)

Path parameters

Name	Type	Required	Description
id	string	yes

Request body (JSON)

Field	Type	Required	Description
until	string	yes

Responses: 200

DELETE /api/dashboard-alerts/{id}/snooze

End the caller’s snooze on an alert

Path parameters

Name	Type	Required	Description
id	string	yes

Responses: 200

GET /api/dashboard-alerts/feed

Fired-alert notifications feed (per-user unread state, cursor traversal, whole-feed counts)

An alert item is a check that told its people: the move into firing, and for an alert on a metric’s period each new period it compares while it stays past its threshold. Its value and threshold are the caller’s own: the number the alert told them (each person is told in their own number), or for the alert’s creator the one it read; for anyone else both are null, the alert only fired. An alert on a metric is listed only for someone who may open Metrics.

Query parameters

Name	Type	Required	Description
limit	integer	no
cursor	string	no
scope	"mine"	no

Responses: 200

POST /api/dashboard-alerts/items/{itemId}/read

Mark one notification read for the caller

Path parameters

Name	Type	Required	Description
itemId	string	yes

Responses: 200

POST /api/dashboard-alerts/mark-read

Mark all notifications read for the caller

Responses: 200