Skip to main content

List alert events

GET 
/api/v1/orgs/{orgId}/alert-events

Retrieve a paginated list of alert events (fired alerts) for an organization. An alert event is created when an alert policy's trigger condition holds for its configured debounce delay; it is later resolved automatically (once the reset condition holds for the delay) or acknowledged manually. All filters are optional and combined with logical AND.

Parameters

  • status (enum, optional): Filter by event status. Valid values: Firing (currently active, not yet resolved), Acknowledged (manually acknowledged, still open), Resolved (closed, either automatically or manually).
  • alertPolicyId (UUID, optional): Filter by the alert policy that fired the event.
  • deviceId (string, optional): Filter by the device the triggering data stream belongs to.
  • start (datetime, optional): Return events fired on or after this timestamp (ISO 8601 UTC).
  • end (datetime, optional): Return events fired before this timestamp (ISO 8601 UTC).
  • sorting (string, optional, default: FiredTime DESC): Sort expression, e.g. firedTime asc.
  • skipCount (integer, optional, default: 0): Number of records to skip.
  • maxResultCount (integer, optional, default: 10): Maximum records to return.

Responses

  • 200 OK: Returns a paginated list of alert events. Each item includes alertEventId, alertPolicyId, policyName (a point-in-time snapshot of the policy name at fire time, unaffected by later renames), deviceId, dataStreamId, status, triggeredValue (the data stream value that caused the trigger), alertLevel (the trigger condition at fire time), firedTime, and — once applicable — acknowledgedTime/acknowledgedBy or resolvedTime/resolvedBy (resolvedBy is null when the event was resolved automatically rather than acknowledged by a person).

Request​

Responses​

OK