{"openapi":"3.1.0","info":{"title":"POST /api/v1/dashboards/{dashboard_id}/widgets/{widget_id}/alert","version":"1.0.0","description":"Create an alert on a metric widget"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}/alert":{"post":{"tags":["dashboards"],"summary":"Create an alert on a metric widget","description":"Create a threshold alert rule bound to a metric widget. The rule is evaluated against the widget's **stored snapshot** — it never re-executes the widget's source tool, so the alert is exactly as fresh as the dashboard itself. Returns 400 if the widget is not a metric widget or if `value_path` does not resolve to a number in the current snapshot.","operationId":"create_widget_alert_api_v1_dashboards__dashboard_id__widgets__widget_id__alert_post","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","title":"Dashboard Id"}},{"name":"widget_id","in":"path","required":true,"schema":{"type":"string","title":"Widget Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetAlertRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WidgetAlertResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreateWidgetAlertRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name"},"threshold_value":{"type":"integer","title":"Threshold Value"},"threshold_direction":{"type":"string","enum":["above","below"],"title":"Threshold Direction"},"value_path":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Value Path"},"channels":{"items":{"type":"string","enum":["inbox","slack","email"]},"type":"array","maxItems":3,"minItems":1,"title":"Channels"},"check_frequency":{"type":"string","enum":["hourly","daily","weekly"],"title":"Check Frequency","default":"daily"},"cooldown_hours":{"type":"integer","maximum":720.0,"minimum":1.0,"title":"Cooldown Hours","default":24},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"slack_channel":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Slack Channel"}},"additionalProperties":false,"type":"object","required":["threshold_value","threshold_direction"],"title":"CreateWidgetAlertRequest","description":"Body for ``POST /dashboards/{id}/widgets/{widget_id}/alert``.\n\nCreates a ``dashboard_metric`` AlertRule bound to one metric widget. The\npoller reads the widget's *stored snapshot* — it never re-executes the\nwidget's source tool (see ``AlertService._get_dashboard_metric_value``)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_WidgetAlertResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/WidgetAlertResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[WidgetAlertResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WidgetAlertResponse":{"properties":{"alert_rule_id":{"type":"string","title":"Alert Rule Id"},"dashboard_id":{"type":"string","title":"Dashboard Id"},"widget_id":{"type":"string","title":"Widget Id"},"name":{"type":"string","title":"Name"},"rule_type":{"type":"string","title":"Rule Type"},"threshold_value":{"type":"integer","title":"Threshold Value"},"threshold_direction":{"type":"string","title":"Threshold Direction"},"value_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Path"},"channels":{"items":{"type":"string"},"type":"array","title":"Channels"},"check_frequency":{"type":"string","title":"Check Frequency"},"cooldown_hours":{"type":"integer","title":"Cooldown Hours"},"is_enabled":{"type":"boolean","title":"Is Enabled","default":true}},"additionalProperties":false,"type":"object","required":["alert_rule_id","dashboard_id","widget_id","name","rule_type","threshold_value","threshold_direction","check_frequency","cooldown_hours"],"title":"WidgetAlertResponse","description":"The created alert rule, echoed back for the widget popover."}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}