Alerts API

Manage data quality and smart alerts with annotations and remediation.

Endpoints Overview

Method	Endpoint	Description
GET	/alerts/spaces/{slug}/alerts	List all alerts
POST	/alerts/{alert_id}/annotate	Add annotation
PATCH	/alerts/{alert_id}/severity	Update severity
PATCH	/alerts/{alert_id}/resolve	Resolve alert
POST	/alerts/{alert_id}/ticket	Create issue from alert

---

Alert Types

Type	Source	Description
dq_alert	Quality checks	Data quality check failures
smart_alert	Platform	AI-detected anomalies
product_alert	Products	Product-level notifications

---

List Alerts

GET /alerts/spaces/{slug}/alerts

Query Parameters

Parameter	Type	Description
status	string	Filter: active, resolved

Response

[
  {
    "id": "...",
    "alert_type": "dq_alert",
    "title": "Freshness check failed",
    "severity": "high",
    "status": "active",
    "product": {
      "id": "...",
      "name": "Customer Events"
    },
    "check": {
      "id": "...",
      "name": "Freshness"
    },
    "annotations": [],
    "created_at": "2026-01-15T10:30:00Z"
  }
]

---

Add Annotation

POST /alerts/{alert_id}/annotate

Add investigation notes or status updates.

{
  "comment": "Investigating upstream pipeline delay."
}

Response

{
  "id": "...",
  "comment": "Investigating upstream pipeline delay.",
  "user": {"id": "...", "full_name": "Alice Johnson"},
  "created_at": "2026-01-15T11:00:00Z"
}

---

Update Severity

PATCH /alerts/{alert_id}/severity?severity=critical

Valid values: low, medium, high, critical

---

Resolve Alert

PATCH /alerts/{alert_id}/resolve

Marks alert as resolved.

---

Create Issue from Alert

POST /alerts/{alert_id}/ticket

Creates a linked issue for tracking resolution.

Response

{
  "ticket_id": "...",
  "title": "Freshness check failed - Customer Events"
}