counters

Retrieve counter by ID

This method retrieves a counter by its ID.

get/counters/{id}/

Path parameters

idinteger required

A unique integer value identifying this Counter.

Response

idinteger required
created_datestring date-time required

Counter creation date

modified_datestring date-time required

Counter modification date

activeboolean
namestring required
commentstring

Extended description, up to 2048 characters

detect_facesboolean

true if face counting enabled

detect_silhouettesboolean

true if silhouette counting enabled

detect_carsboolean

true if cars counting enabled

count_intervalinteger required
roiobject nullable

ROI XY coordinates for related cameras

camerasinteger[] required

Count entities from these cameras (provide either cameras or camera_groups argument)

multi_cameraboolean required

Counter is related to multiple cameras or a single camera

camera_groupsinteger[] required
now_facesinteger required
now_carsinteger required
now_bodiesinteger required
detect_proximityboolean

true if proximity detection enabled

proximity_calibration_status1 | 2 | 3 | 4 | 5 | 6 required
proximity_calibration_data_collection_endstring date-time required

Calibration end date

overall_proximity_minnumber float nullable required
overall_proximity_maxnumber float nullable required
overall_proximity_avgnumber float nullable required
now_proximity_minnumber float nullable required
now_proximity_maxnumber float nullable required
now_proximity_avgnumber float nullable required
proximity_calibration_errorstring required

Proximity calibration error description

Changes