v1

latestOpenAPI 3.0.02026-07-1738124256.1 KB

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"
      },
      "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
  }
}