areas

List areas

This method retrieves the list of areas.

get/areas/

Query parameters

camera_groupsinteger[]

Get areas associated with cameras from camera_group.

camerasinteger[]

Get areas associated with camera. Pass comma separated values to select areas related to multiple cameras

created_date_gtstring date-time

Select objects with created_date greater than this value

created_date_gtestring date-time

Select objects with created_date greater than or equal to this value

created_date_last_n_daysnumber

Select objects with created_date in last N days

created_date_ltstring date-time

Select objects with created_date less than this value

created_date_ltestring date-time

Select objects with created_date less than or equal to this value

created_date_nth_full_weeknumber

Select objects with created_date in last Nth week (including Sunday and Saturday)

created_date_nth_work_weeknumber

Select objects with created_date in last Nth week (only working days, i.e. excluding Sunday and Saturday)

enabledboolean

Select only enabled (true) or disabled (false) areas

id_ininteger[]

Select areas with provided ids

limitstring

Number of results to return per page.

multi_cameraboolean

Select areas related to multiple cameras

name_containsstring

Select counters where the SQL condition name ILIKE name_contains is true

orderingstring

Which field to use when ordering the results. Available fields: id, created_date

pagestring

Pagination cursor value.

Response

next_pagestring nullable
prev_pagestring nullable

Changes

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