Acceldata · Schema

Alert

A data quality or pipeline monitoring alert

AI AgentsData ManagementData ObservabilityData PipelineData QualityIntelligenceObservability

Properties

Name Type Description
id string Unique alert identifier
title string Alert title
severity string Alert severity level
status string Current alert status
ruleId string Data quality rule that triggered this alert
datasetId string Dataset associated with the alert
datasetName string Dataset name
metricValue number Actual metric value that triggered the alert
threshold number Threshold that was exceeded
triggeredAt string When the alert was triggered
View JSON Schema on GitHub

JSON Schema

adoc-api-alert-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://acceldata.io/schemas/alert.json",
  "title": "Alert",
  "type": "object",
  "description": "A data quality or pipeline monitoring alert",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique alert identifier"
    },
    "title": {
      "type": "string",
      "description": "Alert title"
    },
    "severity": {
      "type": "string",
      "description": "Alert severity level",
      "enum": [
        "critical",
        "high",
        "medium",
        "low"
      ]
    },
    "status": {
      "type": "string",
      "description": "Current alert status",
      "enum": [
        "open",
        "resolved",
        "acknowledged"
      ]
    },
    "ruleId": {
      "type": "string",
      "description": "Data quality rule that triggered this alert"
    },
    "datasetId": {
      "type": "string",
      "description": "Dataset associated with the alert"
    },
    "datasetName": {
      "type": "string",
      "description": "Dataset name"
    },
    "metricValue": {
      "type": "number",
      "format": "double",
      "description": "Actual metric value that triggered the alert"
    },
    "threshold": {
      "type": "number",
      "format": "double",
      "description": "Threshold that was exceeded"
    },
    "triggeredAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the alert was triggered"
    }
  }
}