Skip to main content

Alerts

The Alerts API lets developers inspect current alert state, fetch a single alert with metric details, and walk the event timeline for an alert.

Overview​

  • Alerts API overview - shared authentication, pagination, and endpoint overview for the Alerts API

Object references​

  • Alert object - current alert shape returned by list and single-alert endpoints
  • Event object - alert event timeline shape returned by event endpoints

API requests​

  • List active alerts - GET /v1/alerts - list alerts active now or at a specific time, with optional metric expansion
  • Get a single alert - GET /v1/alerts/{alertId} - fetch one alert by id, optionally reconstructed at a time or event sequence
  • List alert events - GET /v1/alerts/{alertId}/events - paginate through the full event history for an alert
  • Get a specific alert event - GET /v1/alerts/{alertId}/events/{sequenceNumber} - fetch one timeline event by sequence number

Notes​

  • All endpoints are tenant-scoped through Authorization: Bearer <token>
  • Time values use ISO 8601 UTC, for example 2025-11-13T12:00:00Z
  • Pagination is 1-based where supported, and limit has a maximum of 100