list_smart_detections
list_smart_detections
Section titled “list_smart_detections”List smart-detection events (person, vehicle, animal, package).
Side effects: None (read-only).
Filters Protect’s event stream to type == "smartDetectZone" and
narrows to entries whose smartDetectTypes contain
detection_type. Empty camera_id returns detections across all
cameras.
Example
Section titled “Example”list_smart_detections(detection_type="person", hours_back=12)Parameters
Section titled “Parameters”| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
detection_type |
string |
no | “person” | One of "person", "vehicle", "animal", "package". Defaults to "person". |
camera_id |
string |
no | “” | Protect camera id. Empty (default) returns matches across all cameras. |
limit |
integer |
no | 20 | Maximum number of events returned. Defaults to 20. |
hours_back |
integer |
no | 24 | Look-back window in hours. Defaults to 24. |
controller |
string |
no | “default” | Name of the UniFi controller to target. Defaults to "default". |