System Details

To retrieve the list of events for a site

This endpoint is used to retrieve the events 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.

An Event is triggered when a site/device meets a pre-defined set of conditions. Each of these pre-defined set of conditions is called an “Event type”. These conditions are defined at both site and device level, therefore events can be triggered at both site and device level. Each event is associated with an event type.

Most Event types (not all) further have pre-defined configurations. Whenever an Event of a given Event type meets these pre-defined configurations, then the Event triggers an Alarm. An example of pre-defined configuration for an event type is - Event status is “Open” beyond a certain time limit.

Events are generated when a site or device meets specific, predefined conditions. These conditions are grouped into what we call “Event types.” Each event is always linked to an event type. For example, ‘Gateway not reporting’ is an event type and an event gets created on a site if the gateway stops reporting. Similarly, if a gateway on another site stops reporting, another event is created specific to that site with the same event type.

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.

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

Request

Path parameters

system_idinteger required

The unique numeric ID of the system.

Query parameters

start_timeinteger required

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

end_timeinteger

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

Response

List of events

system_idinteger

The unique numeric ID of the system.

eventsobject

List of events

Changes

No recorded changes to this operation across all 1 revision of this API.