Create Alert

POST

api

alerts

A valid request URL is required to generate request examples

{
  "data": {
    "displayName": "Checkout error spike",
    "tags": [
      "checkout",
      "p1"
    ],
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "chartConfig": {
      "displayType": "line",
      "sourceId": "65f5e4a3b9e77c001a111111",
      "select": [
        {
          "aggFn": "count",
          "valueExpression": "Duration",
          "alias": "Request Duration",
          "level": 0.5,
          "where": "service:api",
          "whereLanguage": "sql",
          "metricName": "http.server.duration",
          "metricType": "sum",
          "periodAggFn": "delta",
          "numberFormat": {
            "output": "number",
            "mantissa": 2,
            "thousandSeparated": true,
            "average": false,
            "decimalBytes": false,
            "factor": 1,
            "currencySymbol": "$",
            "numericUnit": "bytes_iec",
            "unit": "ms"
          }
        }
      ],
      "groupBy": "host",
      "asRatio": false,
      "alignDateRangeToGranularity": true,
      "fillNulls": true,
      "fitYAxisToData": false,
      "numberFormat": {
        "output": "number",
        "mantissa": 2,
        "thousandSeparated": true,
        "average": false,
        "decimalBytes": false,
        "factor": 1,
        "currencySymbol": "$",
        "numericUnit": "bytes_iec",
        "unit": "ms"
      },
      "compareToPreviousPeriod": false,
      "seriesLimit": 5,
      "formulas": [
        {
          "expression": "A / (A + B) * 100",
          "alias": "Success rate %",
          "numberFormat": {
            "output": "number",
            "mantissa": 2,
            "thousandSeparated": true,
            "average": false,
            "decimalBytes": false,
            "factor": 1,
            "currencySymbol": "$",
            "numericUnit": "bytes_iec",
            "unit": "ms"
          }
        }
      ],
      "showOperandSeries": true,
      "name": "Error Rate Query",
      "where": "ServiceName:api",
      "whereLanguage": "sql"
    },
    "threshold": 100,
    "thresholdMax": 500,
    "interval": "1h",
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "channels": [
      {
        "type": "webhook",
        "webhookId": "65f5e4a3b9e77c001a789012"
      }
    ],
    "name": "Errors for {{group}} hit {{value}}",
    "message": "Test Alert Message",
    "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
    "numConsecutiveWindows": 3,
    "id": "65f5e4a3b9e77c001a123456",
    "state": "ALERT",
    "teamId": "65f5e4a3b9e77c001a345678",
    "silenced": {
      "by": "65f5e4a3b9e77c001a234567",
      "at": "2026-03-19T08:00:00.000Z",
      "until": "2026-03-20T08:00:00.000Z"
    },
    "executionErrors": [
      {
        "timestamp": "2026-04-17T12:00:00.000Z",
        "type": "QUERY_ERROR",
        "message": "Query timed out after 30s"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

التفويضات

Authorization

string

header

مطلوب

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

الجسم

application/json

At least one of "channel" or "channels" must be provided. Sending both is allowed only when "channel" matches the first entry of "channels", so a response body can be echoed back unchanged. Responses always include both, with "channel" mirroring the first entry of "channels".

threshold

number

مطلوب

Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound.

مثال:

100

interval

enum<string>

مطلوب

Evaluation interval for the alert.

الخيارات المتاحة:

1m,

5m,

15m,

30m,

1h,

6h,

12h,

1d

مثال:

"1h"

thresholdType

enum<string>

مطلوب

Threshold comparison direction.

الخيارات المتاحة:

above,

below,

above_exclusive,

below_or_equal,

equal,

not_equal,

between,

not_between

مثال:

"above"

dashboardId

string | null

Dashboard ID for tile-based alerts.

مثال:

"65f5e4a3b9e77c001a567890"

tileId

string | null

Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile.

مثال:

"65f5e4a3b9e77c001a901234"

savedSearchId

string | null

Saved search ID for saved_search alerts.

مثال:

"65f5e4a3b9e77c001a345678"

groupBy

string | null

Group-by key for saved search alerts.

مثال:

"ServiceName"

chartConfig

object

Chart configuration for inline alerts. Required when source is "inline" and rejected otherwise. Returned on single-alert responses (GET by ID, POST, PUT); the list endpoint omits it.

Show child attributes

thresholdMax

number | null

Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold.

مثال:

500

scheduleOffsetMinutes

integer | null

Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC).

النطاق المطلوب: x >= 0

مثال:

2

scheduleStartAt

string<date-time> | null

Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval.

مثال:

"2026-02-08T10:00:00.000Z"

source

enum<string>

Alert source type (tile-based or saved search).

الخيارات المتاحة:

saved_search,

tile,

inline

مثال:

"tile"

channel

object

First notification channel, mirrored from "channels" for pre-multi-channel clients.

Show child attributes

channels

object[]

All notification channels to trigger when the alert fires or resolves.

Required array length: 1 - 10 elements

Show child attributes

name

string | null

Alert name template (Handlebars), rendered as the notification title. When omitted, a default title is generated from the display name, value and threshold.

مثال:

"Errors for {{group}} hit {{value}}"

displayName

string | null

Display name shown in the alerts list and in notification titles. Defaults to the name of the referenced saved search, dashboard tile, or inline chart when omitted or null.

Required string length: 1 - 512

مثال:

"Checkout error spike"

الاستجابة

Successfully created alert

data

object

The alert object.

Show child attributes

آخر تعديل في ٥ سبتمبر ٢٠٢٦

A valid request URL is required to generate request examples

{
  "data": {
    "displayName": "Checkout error spike",
    "tags": [
      "checkout",
      "p1"
    ],
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "chartConfig": {
      "displayType": "line",
      "sourceId": "65f5e4a3b9e77c001a111111",
      "select": [
        {
          "aggFn": "count",
          "valueExpression": "Duration",
          "alias": "Request Duration",
          "level": 0.5,
          "where": "service:api",
          "whereLanguage": "sql",
          "metricName": "http.server.duration",
          "metricType": "sum",
          "periodAggFn": "delta",
          "numberFormat": {
            "output": "number",
            "mantissa": 2,
            "thousandSeparated": true,
            "average": false,
            "decimalBytes": false,
            "factor": 1,
            "currencySymbol": "$",
            "numericUnit": "bytes_iec",
            "unit": "ms"
          }
        }
      ],
      "groupBy": "host",
      "asRatio": false,
      "alignDateRangeToGranularity": true,
      "fillNulls": true,
      "fitYAxisToData": false,
      "numberFormat": {
        "output": "number",
        "mantissa": 2,
        "thousandSeparated": true,
        "average": false,
        "decimalBytes": false,
        "factor": 1,
        "currencySymbol": "$",
        "numericUnit": "bytes_iec",
        "unit": "ms"
      },
      "compareToPreviousPeriod": false,
      "seriesLimit": 5,
      "formulas": [
        {
          "expression": "A / (A + B) * 100",
          "alias": "Success rate %",
          "numberFormat": {
            "output": "number",
            "mantissa": 2,
            "thousandSeparated": true,
            "average": false,
            "decimalBytes": false,
            "factor": 1,
            "currencySymbol": "$",
            "numericUnit": "bytes_iec",
            "unit": "ms"
          }
        }
      ],
      "showOperandSeries": true,
      "name": "Error Rate Query",
      "where": "ServiceName:api",
      "whereLanguage": "sql"
    },
    "threshold": 100,
    "thresholdMax": 500,
    "interval": "1h",
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "channels": [
      {
        "type": "webhook",
        "webhookId": "65f5e4a3b9e77c001a789012"
      }
    ],
    "name": "Errors for {{group}} hit {{value}}",
    "message": "Test Alert Message",
    "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
    "numConsecutiveWindows": 3,
    "id": "65f5e4a3b9e77c001a123456",
    "state": "ALERT",
    "teamId": "65f5e4a3b9e77c001a345678",
    "silenced": {
      "by": "65f5e4a3b9e77c001a234567",
      "at": "2026-03-19T08:00:00.000Z",
      "until": "2026-03-20T08:00:00.000Z"
    },
    "executionErrors": [
      {
        "timestamp": "2026-04-17T12:00:00.000Z",
        "type": "QUERY_ERROR",
        "message": "Query timed out after 30s"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}

Get started

Features

Managing ClickStack

Guides

Integration partners

التفويضات

الجسم

الاستجابة