System Details

To retrieve the list of alarms for a site

Changed on

This endpoint is used to retrieve the alarms for a site. start_time is mandatory and cannot be older than 9 months from the current time. Maximum 1 week of data can be retrieved in a single call.

Many event types (though not all) come with predefined escalation criteria for alarms. When an event meets these configurations, it can trigger an alarm. For example, a common configuration might specify that an event should trigger an alarm if its status remains “Open” beyond a certain time threshold.

An Alarm is always tied to an Event, and the relationship between them can be one-to-one or one-to-many. For instance, if a site has a single battery and its State of Charge (SOC) drops below a predefined threshold, an event is created. If the SOC remains below that threshold for a specified duration, an alarm is triggered for that battery. In another scenario, if a site has multiple batteries and all of them fall below the SOC threshold, individual events are created for each battery. If the low SOC condition persists across all batteries for the defined time period, a single alarm may be triggered for all of them.

This means:

  • An alarm can be associated with multiple events.

  • But an event can be associated with only one alarm.

get/api/v4/systems/{system_id}/alarms

Request

Path parameters

system_idinteger required

The unique numeric ID of the system.

Query parameters

start_timeinteger required

Requested start time of the alarms data in Epoch time format.

end_timeinteger

Requested end time of the alarms data in Epoch time format. Defaults to minimum (start time + 1 day, current time)

clearedboolean

Filters alarms based on their status. Set to true to return cleared alarms; defaults to false to return active alarms.

Response

List of alarms

system_idinteger

The unique numeric ID of the system.

alarmsobject

List of alarms

Changes