Region

A polygonal area in which EyesOnIt evaluates detections.

Example

{
  "name": "Front Entrance",
  "enabled": true,
  "polygon": [
    { "x": 528, "y": 175 },
    { "x": 876, "y": 166 },
    { "x": 896, "y": 285 },
    { "x": 506, "y": 279 }
  ],
  "motion_detection": {
    "enabled": true,
    "detection_threshold": 300,
    "regular_check_frame_interval": 5
  },
  "detection_configs": []
}

Fields

Field	Type	Description
id	number	Region identifier when returned by the server.
enabled	boolean	Enable or disable the region.
name	string	Region name used in results and alerts.
polygon	Vertex[]	Vertices that define the polygon.
detection_configs	Detection Configuration[]	Detection rules for the region.
motion_detection	Motion Detection	Motion-detection settings for the region.