Alerts

List Alerts

Retrieves alerts for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When more records exist than are returned, meta.total exceeds data.length; clients with large collections must page with limit/offset to retrieve them all.

get/api/v2/alerts

Query parameters

limitinteger

Maximum number of alerts to return.

offsetinteger

Number of alerts to skip before returning results.

Response

Successfully retrieved alerts

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"
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 100
  }
}

Changes

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

Aug 21, 2026578ecc427dd81See the full diff
- ○
  added the optional property data/items/allOf[Alert]/channels to the response with the 200 status
  response-optional-property-added
Aug 11, 20260c6c6e7444061See the full diff
- ●
  added the new QUERY_TIMEOUT enum value to the data/items/allOf[subschema #2]/executionErrors/items/type response property for the response status 200
  response-property-enum-value-added
Jul 8, 20266f43817301235See the full diff
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  the response property data became required for the status 200
  response-property-became-required
- ○
  added the required property meta to the response with the 200 status
  response-required-property-added
Jul 6, 2026e3a538a92f6711See the full diff
- ●
  added the new PENDING enum value to the data/items/allOf[subschema #2]/state response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property data/items/allOf[Alert]/numConsecutiveWindows to the response with the 200 status
  response-optional-property-added
May 13, 2026b3055248af4f1See the full diff
- ○
  added the optional property data/items/allOf[Alert]/note to the response with the 200 status
  response-optional-property-added
Apr 17, 202649ba4aeaa9b41See the full diff
- ○
  added the optional property data/items/allOf[subschema #2]/executionErrors to the response with the 200 status
  response-optional-property-added
Apr 17, 202636a5514b174521See the full diff
- ●
  added the new between enum value to the data/items/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/items/allOf[Alert]/thresholdType response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property data/items/allOf[Alert]/thresholdMax to the response with the 200 status
  response-optional-property-added
Apr 16, 2026dbf09188d84e4See the full diff
- ●
  added the new above_exclusive enum value to the data/items/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/items/allOf[Alert]/thresholdType response property for the response status 200
  response-property-enum-value-added
- ●
  added the new equal enum value to the data/items/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/items/allOf[Alert]/thresholdType response property for the response status 200
  response-property-enum-value-added
Mar 6, 2026d895d0cbdd272See the full diff
- ○
  added the optional property data/items/allOf[Alert]/scheduleOffsetMinutes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/allOf[Alert]/scheduleStartAt to the response with the 200 status
  response-optional-property-added
Feb 2, 2026e856dc2f14171171See the full diff
- ▲
  the data/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property data/items/channel from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/createdAt from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/dashboard from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/groupBy from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/interval from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/message from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/savedSearch from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/silenced from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/source from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/state from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/team from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/threshold from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/thresholdType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/tileId from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/updatedAt from the response with the 200 status
  response-optional-property-removed
- ○
  added Alert subschema #2 to the data/items/ response property allOf list for the response status 200
  response-property-all-of-added

Full history (11 revisions)