Skip to main content

Alert Rules

The task of alert rules is to determine which noncompliance a camera will monitor and in which areas it can alert.

Export alert rules

GET/alert_rules/export

Arguments

Query String Parameters
  • format Enum optional
    • CSV (default)
    • JSON
    • JSONL

Returns

Returns list of alert rule objects for given format.

FieldTypeDescription
idUUIDUnique identifier for alert rule
nameEnumAlert rule name ex: LINE_OF_FIRE, APRON
cameraIdUUIDUnique identifier for a camera in which alert rule is created from
severityEnumSeverity type ex: HIGH, MEDIUM & LOW
statusEnumThe field shows that rule status ex: ACTIVE, INACTIVE
observationBoolThe field shows that an alert is created for just observation or not
createdAtDateTimeThe field shows creation time of the alert rule
id,name,cameraId,severity,status,observation,createdAt
4b8f669d-1e1c-438e-8488-8d6d0c3ddde6,HELMET,27fd644b-23fa-426b-a93c-163a3328993f,MEDIUM,ACTIVE,false,2022-10-04T20:47:00Z
81e83ddd-8795-43d5-a1e3-91372d339c4e,STATIC_DELIMITATION_AREA,27fd644b-23fa-426b-a93c-163a3328993f,LOW,ACTIVE,false,2022-11-05T20:47:00Z