Query Alert Statistics

Last Updated on : 2023-06-15 06:03:34

Query the data of alerts.

API address

GET: /v1.0/si/iot-03/alarm-statistics

Request parameter

Parameter nameTypeINRequiredDescription
monitor_object_typeStringquerytrueThe type of a specified monitored object. Valid values:
  • energy_collect: industrial energy consumption.
  • environment: industrial environment.
  • vibration: industrial vibration.

Return parameter

Parameter nameTypeDescription
resultMonitorAlarmStatisticDTOThe returned result.

Description of result

Parameter nameTypeDescription
low_level_numIntegerThe number of low-level alerts.
total_numIntegerThe total number of alerts.
high_level_numIntegerThe number of high-level alerts.
normal_numIntegerThe number of normal records.
today_numIntegerThe number of today's newly increased alerts.
unprocessed_numIntegerThe number of unhandled alerts.

Request example

GET: /v1.0/si/iot-03/alarm-statistics?monitorObjectType=environment

Return example

{
    "result": {
        "today_num": 0,
        "unprocessed_num": 0,
        "total_num": 0
    },
    "t": 1639623296602,
    "success": true
}

Error code

For more information, see error code.