DUET PlatformDocs
API referenceRead APIAlarms

List alarm events

available
GET
/platform/v1/alarms/events

Lists the alarm lifecycle events in a project as a flat feed. Rows are sorted by synced_at, oldest first. You can filter by site. To read incrementally, use the updated_since, after, and after_event_id watermark. All IDs are DUET IDs.

Authorization

Bearer
headerAuthorizationBearer <token>

Query Parameters

project_id*string

The ID of the project to read alarm events from.

site?string

Returns only events from this site.

updated_since?string

The replay watermark. Returns events that DUET stored at or after this time, compared against synced_at. Rows are sorted by synced_at, oldest first. To resume, set updated_since to the last row's synced_at, after to its duet_occurrence_ref, and after_event_id to its event_id.

Formatdate-time
after?string

The duet_occurrence_ref of the last event you received. Requires updated_since and after_event_id.

after_event_id?string

The event_id of the last event you received. Requires updated_since and after.

limit?integer

The maximum number of rows to return. The default is 10,000 and the maximum is 100,000. A page with fewer than limit rows is the last page.

Range1 <= value <= 100000
Default10000
offset?|

The number of rows to skip. For replay, use the updated_since and after watermark instead. An offset can skip or repeat rows when rows change between pages.

Range0 <= value
Default0

Response Body

The alarm events, oldest synced_at first.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/alarms/events?project_id=string'
Example Response
[  {    "event_id": "string",    "occurrence_id": "string",    "duet_occurrence_ref": "string",    "type": "raised",    "kind": "string",    "created_at": "2019-08-24T14:15:22Z",    "synced_at": "2019-08-24T14:15:22Z",    "body": "string",    "user_id": "string",    "user_email": "string",    "external_user_id": "string",    "detail": null  }]