Sign in
areas

Retrieve area by ID

This method retrieves an area by its ID.

get/areas/{id}/

Path parameters

idinteger required

A unique integer value identifying this Area.

Response

idinteger required
created_datestring date-time required

Area creation date

modified_datestring date-time required

Area modification date

namestring required

Area name, up to 256 characters

enabledboolean

true if the area is enabled

trigger_count_gtinteger nullable

gt people on a frame are required for trigger activation

trigger_count_ltinteger nullable

lt people on a frame are required for trigger activation

trigger_timeinteger required

Minimum time in seconds conditions should be met to activate triggers

scheduled_nowboolean required
camera_groupsinteger[] required
camerasinteger[] required

Monitor area for these cameras

multi_cameraboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.