Alerts

Get Alert

Retrieves a specific alert by ID

get/api/v2/alerts/{id}

Path parameters

idstring required

Alert ID

Response

Successfully retrieved alert

Example response

{
  "data": {
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "threshold": 100,
    "thresholdMax": 500,
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "channel": {
      "webhookId": "65f5e4a3b9e77c001a789012"
    },
    "channels": [
      {
        "webhookId": "65f5e4a3b9e77c001a789012"
      }
    ],
    "name": "Test Alert",
    "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",
    "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",
        "message": "Query timed out after 30s"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 11 of the 60 revisions of this API.22528

    • added the optional property data/allOf[Alert]/channels to the response with the 200 status

      response-optional-property-added

    • added the new QUERY_TIMEOUT enum value to the data/allOf[subschema #2]/executionErrors/items/type response property for the response status 200

      response-property-enum-value-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the new PENDING enum value to the data/allOf[subschema #2]/state response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/allOf[Alert]/numConsecutiveWindows to the response with the 200 status

      response-optional-property-added

    • added the optional property data/allOf[Alert]/note to the response with the 200 status

      response-optional-property-added

    • added the optional property data/allOf[subschema #2]/executionErrors to the response with the 200 status

      response-optional-property-added

  • 36a5514b174521See the full diff
    • added the new between enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the new not_between enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/allOf[Alert]/thresholdMax to the response with the 200 status

      response-optional-property-added

    • added the new above_exclusive enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the new below_or_equal enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the new equal enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the new not_equal enum value to the data/allOf[Alert]/thresholdType response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/allOf[Alert]/scheduleOffsetMinutes to the response with the 200 status

      response-optional-property-added

    • added the optional property data/allOf[Alert]/scheduleStartAt to the response with the 200 status

      response-optional-property-added

  • e856dc2f14171171See the full diff
    • the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property data/channel from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/createdAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/dashboard from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/groupBy from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/interval from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/message from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/savedSearch from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/silenced from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/source from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/state from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/team from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/threshold from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/thresholdType from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/tileId from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/updatedAt from the response with the 200 status

      response-optional-property-removed

    • added Alert subschema #2 to the data response property allOf list for the response status 200

      response-property-all-of-added