Alert Events

This section provides examples for Alert event types.

Historical

URI Method Description 
/ids-data-api/v1/alert-events/history?fromTime=<fromTime>&toTime=<toTime>&deviceId=<deviceIds>&ruleId=<ruleIds>&severity=<severities>
GET This API retrieves all the alert events. If rule and severity are specified in the query params then events will be filtered based on those params.

Method: GET

URI: 

http://impactids-edge-01/ids-data-api/v1/alert-events/history?fromTime=2000-01-01T00:00:00&toTime=2021-12-31T00:00:00&deviceId=352253064335284& ruleId=897e5700-f4d2-11eb-b946-2bf1e55ffb13

Response: 200 OK:

[
    {
        "groupName": "auto1",
        "deviceId": "352253064335284",
        "serverTime": "2017-01-25T10:23:33.341+0000",
        "ruleName": "ObserveNotifyAlerts",
        "ruleId": "897e5700-f4d2-11eb-b946-2bf1e55ffb13",
        "details": {
            "serialNumber": "352253064335284"
        },
        "severity": "UNDEFINED"
    }
]

Bulk

URI Method Description 
/ids-data-api/v1/alert-events/bulk?fromTime=<fromTime>&toTime=<toTime>
 GET This API retrieves all the alerts in the specified time range. The response consists of a list of JSON formatted data, separated by newlines.

Method: GET

URI: 

http://impactids-edge-01/ids-data-api/v1/alert-events/bulk?fromTime=2015-01-01T00:00:00&toTime=2022-12-01T00:00:00

Response: 200 OK:

{"groupName":"auto1","deviceId":"352253064335284","serverTime":1485339813341, "ruleName":"ObserveNotifyAlerts","ruleId":"897e5700-f4d2-11eb-b946-2bf1e55ffb13","details":{"serialNumber":"352253064335284"},"severity":"UNDEFINED"}