# info.description
**Authentication**
All API methods require a simple token-based HTTP Authentication. To authenticate, put word "Token" and a token, separated by whitespace into the Authorization HTTP header:
`Authorization: Token 000...`
All requests that fail to provide a valid authentication token will result in an HTTP 401 Unauthorized response.

**Parameters Format**
*There are two ways to pass parameters to the API methods:*
- application/json: parameters are represented by a JSON contained in the body.
- multipart/form-data: parameters are encoded into separate parts. This way supports uploading a photo image file in the same request.

**Additional Information**
*Standard extraction limits:*
- Image formats: 	JPEG, PNG, WEBP
- Maximum photo file size: 	10 MB
- Maximum photo resolution: 	6000 pixels on the biggest side
- Minimal size of a face: 	50x50 pixels

Check *findface-extraction-api.yaml* for custom definition

# paths./area-trigger-activations/.get.description
This method retrieves the list of area trigger activations.

# paths./area-trigger-activations/.get.parameters[].description
Select only active (`true`) or inactive (`false`) area trigger activations

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger activations related to one or multiple `area`s

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./area-trigger-activations/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger activations with `duration` **greater than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger activations with `duration` **less than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger's activations with provided ids

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger activations with `max_body_count` **greater than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Select area trigger activations with `max_body_count` **less than or equal** to this value

# paths./area-trigger-activations/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./area-trigger-activations/{id}/.get.description
This method retrieves an area trigger activation by its ID.

# paths./area-trigger-activations/{id}/.get.parameters[].description
A unique integer value identifying this Area trigger activation.

# paths./area-trigger-activations/count/.get.parameters[].description
Select only active (`true`) or inactive (`false`) area trigger activations

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger activations related to one or multiple `area`s

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./area-trigger-activations/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger activations with `duration` **greater than or equal** to this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger activations with `duration` **less than or equal** to this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger's activations with provided ids

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger activations with `max_body_count` **greater than or equal** to this value

# paths./area-trigger-activations/count/.get.parameters[].description
Select area trigger activations with `max_body_count` **less than or equal** to this value

# paths./area-trigger-records/.get.description
This method retrieves the list of area trigger records.

# paths./area-trigger-records/.get.parameters[].description
Select area trigger records related to one or multiple `area`s

# paths./area-trigger-records/.get.parameters[].description
Select area trigger records related to one or multiple `area trigger activation`s

# paths./area-trigger-records/.get.parameters[].description
Select area trigger records with `body_count` **greater than or equal** to this value

# paths./area-trigger-records/.get.parameters[].description
Select area trigger records with `body_count` **less than or equal** to this value

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./area-trigger-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./area-trigger-records/.get.parameters[].description
Select area trigger's records with provided ids

# paths./area-trigger-records/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./area-trigger-records/{id}/.get.description
This method retrieves an area trigger record by its ID.

# paths./area-trigger-records/{id}/.get.parameters[].description
A unique integer value identifying this Area trigger record.

# paths./area-trigger-records/count/.get.parameters[].description
Select area trigger records related to one or multiple `area`s

# paths./area-trigger-records/count/.get.parameters[].description
Select area trigger records related to one or multiple `area trigger activation`s

# paths./area-trigger-records/count/.get.parameters[].description
Select area trigger records with `body_count` **greater than or equal** to this value

# paths./area-trigger-records/count/.get.parameters[].description
Select area trigger records with `body_count` **less than or equal** to this value

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./area-trigger-records/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./area-trigger-records/count/.get.parameters[].description
Select area trigger's records with provided ids

# paths./areas/.get.description
This method retrieves the list of areas.

# paths./areas/.get.parameters[].description
Get areas associated with cameras from `camera_group`.

# paths./areas/.get.parameters[].description
Get areas associated with `camera`. Pass comma separated values to select areas related to multiple `camera`s

# paths./areas/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./areas/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./areas/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./areas/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./areas/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./areas/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./areas/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./areas/.get.parameters[].description
Select only enabled (`true`) or disabled (`false`) areas

# paths./areas/.get.parameters[].description
Select areas related to multiple cameras

# paths./areas/.get.parameters[].description
Select counters where the SQL condition `name ILIKE name_contains` is true

# paths./areas/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./areas/{id}/.get.description
This method retrieves an area by its ID.

# paths./areas/{id}/.get.parameters[].description
A unique integer value identifying this Area.

# paths./areas/{id}/.patch.description
Use this method to update an area properties.

# paths./areas/{id}/.patch.parameters[].description
A unique integer value identifying this Area.

# paths./areas/{id}/.delete.parameters[].description
A unique integer value identifying this Area.

# paths./areas/count/.get.parameters[].description
Get areas associated with cameras from `camera_group`.

# paths./areas/count/.get.parameters[].description
Get areas associated with `camera`. Pass comma separated values to select areas related to multiple `camera`s

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./areas/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./areas/count/.get.parameters[].description
Select only enabled (`true`) or disabled (`false`) areas

# paths./areas/count/.get.parameters[].description
Select areas related to multiple cameras

# paths./areas/count/.get.parameters[].description
Select counters where the SQL condition `name ILIKE name_contains` is true

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `action_type`

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./audit-logs/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `device_uid`

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `object_id`

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `object_type`

# paths./audit-logs/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `request_ip`

# paths./audit-logs/.get.parameters[].description
Select audit-log entries that matched this `user_id`

# paths./audit-logs/.get.parameters[].description
Select audit-log entries with this `user_login`

# paths./audit-logs/{id}/.get.parameters[].description
A unique integer value identifying this Audit log.

# paths./auth/login/.post.description
Use this method to obtain an authorization token that you can use in all other methods.

To use method you should provide basic authorization credentials:

 - `Username` - username of your FF.Multi account
 - `Password` - password for your FF.Multi account

This method returns a structure containing an authorization `token`.

Copy its value, prepend it with "Token" and paste the entire thing into the **API Key** field
in the authorization form of this documentation viewer.

If the system uses face AND password authorization - 
together with the Basic authorization header, 
additionally pass the token received during face authorization in the `video_auth_token` field. 

# paths./auth/login/.post.summary
Create authorization token from username and password

# paths./auth/logout/.post.description
This method invalidates the token that is currently in use.

# paths./auth/video-auth/.post.description
Use this operation to obtain an authorization token which could be used in all other operations.

To use this handler, send a video file that shows the face of the user being logged in.

This method returns a structure containing authorization `token`.

Copy its value, prepend it with "Token" and paste the entire thing into the **API Key** field
in the authorization form of this documentation viewer.

If the system uses face and password authentication, save the token received during face authentication 
(it will be inactive until the correct password is entered) and pass it 
along with basic authorization to the `/auth/login/` handler.

# paths./auth/video-auth-renew/.post.description
Use this operation to renew an authorization token

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./camera-groups/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./camera-groups/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./camera-groups/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `modified_date`, `name`, `active`

# paths./camera-groups/{id}/.get.parameters[].description
A unique integer value identifying this Camera groups.

# paths./camera-groups/{id}/.patch.parameters[].description
A unique integer value identifying this Camera groups.

# paths./camera-groups/{id}/.delete.parameters[].description
A unique integer value identifying this Camera groups.

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./camera-groups/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./camera-groups/count/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./cameras/.get.description
This method retrieves the list of cameras.

# paths./cameras/.get.parameters[].description
Select only active cameras (`true`) or inactive cameras (`false`)

# paths./cameras/.get.parameters[].description
Select cameras included in these camera groups

# paths./cameras/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cameras/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cameras/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cameras/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cameras/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cameras/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cameras/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cameras/.get.parameters[].description
Select only external detectors (`true`) or cameras (`false`)

# paths./cameras/.get.parameters[].description
Select cameras included in these `external_vms`

# paths./cameras/.get.parameters[].description
Select camera exact with this `external_vms_camera_id`

# paths./cameras/.get.parameters[].description
`true` - select all cameras from external_vms. `false` - select all cameras not from external_vms.

# paths./cameras/.get.parameters[].description
`true` - select only cameras with latitude and longitude. `false` - select only cameras without latitude and longitude.

# paths./cameras/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./cameras/.get.parameters[].description
Select cameras where latitude **greater than or equal** to this value

# paths./cameras/.get.parameters[].description
Select cameras where latitude **less than or equal** to this value

# paths./cameras/.get.parameters[].description
Select cameras where longitude **greater than or equal** to this value

# paths./cameras/.get.parameters[].description
Select cameras where longitude **less than or equal** to this value

# paths./cameras/.get.parameters[].description
Select cameras where the SQL condition `name ILIKE name_contains` is true

# paths./cameras/.get.parameters[].description
Select cameras that support a given type of object: face, body or car

# paths./cameras/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./cameras/.get.parameters[].description
Select cameras by status (`gray`, `red`, `yellow` or `green`)

# paths./cameras/{id}/.get.description
This method retrieves a camera by its ID.

# paths./cameras/{id}/.get.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/.put.description
Use this method to update a camera properties.

# paths./cameras/{id}/.put.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/.patch.description
Use this method to update a camera properties.

# paths./cameras/{id}/.patch.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/.delete.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/goto-preset/.post.description
Use this method to move ONVIF device to PTZ preset.

# paths./cameras/{id}/goto-preset/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/ptz/.post.description
Use this method to move ONVIF device via pinch/tilt/zoom actions.

# paths./cameras/{id}/ptz/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/ptz-presets/.post.description
Use this method to list ONVIF device PTZ presets for media profile.

# paths./cameras/{id}/ptz-presets/.post.summary
List ONVIF device PTZ presets for media profile

# paths./cameras/{id}/ptz-presets/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/remove-preset/.post.description
Use this method to remove ONVIF device PTZ preset.

# paths./cameras/{id}/remove-preset/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/restart/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/screenshot/.get.description
Use this method to retrieve a screenshot from a camera video stream (can be cached).

# paths./cameras/{id}/screenshot/.get.summary
Retrieve a screenshot from camera stream (can be cached)

# paths./cameras/{id}/screenshot/.get.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/screenshot/.get.parameters[].description
Screenshot quality (the value can be ignored if the stream is not processed by the findface-video-worker)

# paths./cameras/{id}/screenshot/.get.parameters[].description
Either request screenshot with ROT or without

# paths./cameras/{id}/screenshot/.post.description
This method retrieves a screenshot from a camera video stream (cache invalidated).

# paths./cameras/{id}/screenshot/.post.summary
Retrieve a screenshot of the camera stream (invalidates cache)

# paths./cameras/{id}/screenshot/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/{id}/screenshot/.post.parameters[].description
Screenshot quality (the value can be ignored if the stream is not processed by the findface-video-worker)

# paths./cameras/{id}/screenshot/.post.parameters[].description
Either request screenshot with ROT or without

# paths./cameras/{id}/set-preset/.post.description
Use this method to create ONVIF device PTZ preset based on current position.

# paths./cameras/{id}/set-preset/.post.summary
Create ONVIF device PTZ preset based on current position

# paths./cameras/{id}/set-preset/.post.parameters[].description
A unique integer value identifying this Camera.

# paths./cameras/count/.get.parameters[].description
Select only active cameras (`true`) or inactive cameras (`false`)

# paths./cameras/count/.get.parameters[].description
Select cameras included in these camera groups

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cameras/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cameras/count/.get.parameters[].description
Select only external detectors (`true`) or cameras (`false`)

# paths./cameras/count/.get.parameters[].description
Select cameras included in these `external_vms`

# paths./cameras/count/.get.parameters[].description
Select camera exact with this `external_vms_camera_id`

# paths./cameras/count/.get.parameters[].description
`true` - select all cameras from external_vms. `false` - select all cameras not from external_vms.

# paths./cameras/count/.get.parameters[].description
`true` - select only cameras with latitude and longitude. `false` - select only cameras without latitude and longitude.

# paths./cameras/count/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select cameras where latitude **greater than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select cameras where latitude **less than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select cameras where longitude **greater than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select cameras where longitude **less than or equal** to this value

# paths./cameras/count/.get.parameters[].description
Select cameras where the SQL condition `name ILIKE name_contains` is true

# paths./cameras/count/.get.parameters[].description
Select cameras that support a given type of object: face, body or car

# paths./cameras/count/.get.parameters[].description
Select cameras by status (`gray`, `red`, `yellow` or `green`)

# paths./cameras/default_parameters/.get.description
This method retrieves default values of the `stream_settings` parameters.

# paths./cameras/default_parameters/.get.summary
Retrieve default values of `stream_settings` parameters

# paths./car-card-attachments/.get.parameters[].description
Select attachments related to `car card`

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./car-card-attachments/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./car-card-attachments/{id}/.get.parameters[].description
A unique integer value identifying this Car card attachment.

# paths./car-card-attachments/{id}/.put.parameters[].description
A unique integer value identifying this Car card attachment.

# paths./car-card-attachments/{id}/.patch.parameters[].description
A unique integer value identifying this Car card attachment.

# paths./car-card-attachments/{id}/.delete.parameters[].description
A unique integer value identifying this Car card attachment.

# paths./cards/cars/.get.parameters[].description
Select only active (`true`) or disabled (`false`) cards

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cards/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/cars/.get.parameters[].description
Select only filled (`true`) or infilled (`false`) cards

# paths./cards/cars/.get.parameters[].description
Select only cards with linked car objects (`true`) or without them (`false`)

# paths./cards/cars/.get.parameters[].description
Select cards where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./cards/cars/.get.parameters[].description
Select cards that contain object similar to: (`detection:<detection id>`, `{face, body, or car}event:<event id>` `{face, body, or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./cards/cars/.get.parameters[].description
Select objects with `modified_date` **greater** than this value

# paths./cards/cars/.get.parameters[].description
Select objects with `modified_date` **greater than or equal** to this value

# paths./cards/cars/.get.parameters[].description
Select objects with `modified_date` **less** than this value

# paths./cards/cars/.get.parameters[].description
Select objects with `modified_date` **less than or equal** to this value

# paths./cards/cars/.get.parameters[].description
Select objects that were modified in last N days

# paths./cards/cars/.get.parameters[].description
Select objects that were modified in last Nth week (including Sunday and Saturday)

# paths./cards/cars/.get.parameters[].description
Select objects that were modified in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/cars/.get.parameters[].description
Select cards where the SQL condition `name ILIKE name_contains` is true

# paths./cards/cars/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`, `looks_like_confidence`

# paths./cards/cars/.get.parameters[].description
Select cards included in these watch lists

# paths./cards/cars/{id}/.get.description
Use this method to retrieve a car card by its ID.

# paths./cards/cars/{id}/.get.parameters[].description
A unique integer value identifying this Car card.

# paths./cards/cars/{id}/.patch.description
Use this method to update a car card properties.

# paths./cards/cars/{id}/.patch.parameters[].description
A unique integer value identifying this Car card.

# paths./cards/cars/{id}/.delete.parameters[].description
A unique integer value identifying this Car card.

# paths./cards/cars/count/.get.description
This method retrieves a count of car cards.

# paths./cards/cars/count/.get.parameters[].description
Select only active (`true`) or disabled (`false`) cards

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cards/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/cars/count/.get.parameters[].description
Select only filled (`true`) or infilled (`false`) cards

# paths./cards/cars/count/.get.parameters[].description
Select only cards with linked car objects (`true`) or without them (`false`)

# paths./cards/cars/count/.get.parameters[].description
Select cards where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./cards/cars/count/.get.parameters[].description
Select objects with `modified_date` **greater** than this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `modified_date` **greater than or equal** to this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `modified_date` **less** than this value

# paths./cards/cars/count/.get.parameters[].description
Select objects with `modified_date` **less than or equal** to this value

# paths./cards/cars/count/.get.parameters[].description
Select objects that were modified in last N days

# paths./cards/cars/count/.get.parameters[].description
Select objects that were modified in last Nth week (including Sunday and Saturday)

# paths./cards/cars/count/.get.parameters[].description
Select objects that were modified in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/cars/count/.get.parameters[].description
Select cards where the SQL condition `name ILIKE name_contains` is true

# paths./cards/cars/count/.get.parameters[].description
Select cards included in these watch lists

# paths./cards/humans/.get.parameters[].description
Select only active (`true`) or disabled (`false`) cards

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cards/humans/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/humans/.get.parameters[].description
Select only filled (`true`) or infilled (`false`) cards

# paths./cards/humans/.get.parameters[].description
Select only cards with linked body objects (`true`) or without them (`false`)

# paths./cards/humans/.get.parameters[].description
Select only cards with linked face objects (`true`) or without them (`false`)

# paths./cards/humans/.get.parameters[].description
Select cards that contain object similar to: (`detection:<detection id>`, `{face, body, or car}event:<event id>` `{face, body, or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./cards/humans/.get.parameters[].description
Select objects with `modified_date` **greater** than this value

# paths./cards/humans/.get.parameters[].description
Select objects with `modified_date` **greater than or equal** to this value

# paths./cards/humans/.get.parameters[].description
Select objects with `modified_date` **less** than this value

# paths./cards/humans/.get.parameters[].description
Select objects with `modified_date` **less than or equal** to this value

# paths./cards/humans/.get.parameters[].description
Select objects that were modified in last N days

# paths./cards/humans/.get.parameters[].description
Select objects that were modified in last Nth week (including Sunday and Saturday)

# paths./cards/humans/.get.parameters[].description
Select objects that were modified in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/humans/.get.parameters[].description
Select cards where the SQL condition `name ILIKE name_contains` is true

# paths./cards/humans/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`, `looks_like_confidence`

# paths./cards/humans/.get.parameters[].description
Select cards included in these watch lists

# paths./cards/humans/.post.description
Use this method to add a new human card.

# paths./cards/humans/{id}/.get.description
Use this method to retrieve a human card by its ID.

# paths./cards/humans/{id}/.get.parameters[].description
A unique integer value identifying this Human card.

# paths./cards/humans/{id}/.patch.description
Use this method to update a human card properties.

# paths./cards/humans/{id}/.patch.parameters[].description
A unique integer value identifying this Human card.

# paths./cards/humans/{id}/.delete.parameters[].description
A unique integer value identifying this Human card.

# paths./cards/humans/count/.get.description
This method retrieves a count of human cards.

# paths./cards/humans/count/.get.parameters[].description
Select only active (`true`) or disabled (`false`) cards

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cards/humans/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/humans/count/.get.parameters[].description
Select only filled (`true`) or infilled (`false`) cards

# paths./cards/humans/count/.get.parameters[].description
Select only cards with linked body objects (`true`) or without them (`false`)

# paths./cards/humans/count/.get.parameters[].description
Select only cards with linked face objects (`true`) or without them (`false`)

# paths./cards/humans/count/.get.parameters[].description
Select objects with `modified_date` **greater** than this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `modified_date` **greater than or equal** to this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `modified_date` **less** than this value

# paths./cards/humans/count/.get.parameters[].description
Select objects with `modified_date` **less than or equal** to this value

# paths./cards/humans/count/.get.parameters[].description
Select objects that were modified in last N days

# paths./cards/humans/count/.get.parameters[].description
Select objects that were modified in last Nth week (including Sunday and Saturday)

# paths./cards/humans/count/.get.parameters[].description
Select objects that were modified in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cards/humans/count/.get.parameters[].description
Select cards where the SQL condition `name ILIKE name_contains` is true

# paths./cards/humans/count/.get.parameters[].description
Select cards included in these watch lists

# paths./cluster-events/bodies/.get.description
Use this method to list body cluster events.

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `age_group` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `bag_back` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `bag_ground` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `bag_hand` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `gender` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `color` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/bodies/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/bodies/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/bodies/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `detailed_upper_clothes` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/bodies/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/bodies/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `headwear` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `helmet_type` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `lower_clothes` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/bodies/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `top_color` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `upper_clothes` takes one of these values

# paths./cluster-events/bodies/.get.parameters[].description
Select objects where feature `vest_type` takes one of these values

# paths./cluster-events/bodies/{id}/.get.description
Use this method to retrieve body cluster event by ID

# paths./cluster-events/bodies/{id}/.get.parameters[].description
A unique integer value identifying this Body cluster event.

# paths./cluster-events/bodies/{id}/.put.description
Use this method to update body cluster event properties

# paths./cluster-events/bodies/{id}/.put.parameters[].description
A unique integer value identifying this Body cluster event.

# paths./cluster-events/bodies/{id}/.patch.description
Use this method to update body cluster event properties

# paths./cluster-events/bodies/{id}/.patch.parameters[].description
A unique integer value identifying this Body cluster event.

# paths./cluster-events/bodies/{id}/.delete.description
Use this method to delete body cluster event

# paths./cluster-events/bodies/{id}/.delete.parameters[].description
A unique integer value identifying this Body cluster event.

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `age_group` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `bag_back` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `bag_ground` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `bag_hand` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `gender` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `color` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/bodies/count/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `detailed_upper_clothes` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/bodies/count/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/bodies/count/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `headwear` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `helmet_type` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `lower_clothes` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `top_color` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `upper_clothes` takes one of these values

# paths./cluster-events/bodies/count/.get.parameters[].description
Select objects where feature `vest_type` takes one of these values

# paths./cluster-events/cars/.get.description
Use this method to list car cluster events.

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `body` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/cars/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/cars/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `category` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `color` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/cars/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/cars/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/cars/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `license_plate_country` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `license_plate_number_color` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `license_plate_number` contains this substring (case insensitive)

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `license_plate_region` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `make` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `model` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `special_vehicle_type` takes one of these values

# paths./cluster-events/cars/.get.parameters[].description
Select objects where feature `weight_type` takes one of these values

# paths./cluster-events/cars/{id}/.get.description
Use this method to retrieve car cluster event by ID

# paths./cluster-events/cars/{id}/.get.parameters[].description
A unique integer value identifying this Car cluster event.

# paths./cluster-events/cars/{id}/.put.description
Use this method to update car cluster event properties

# paths./cluster-events/cars/{id}/.put.parameters[].description
A unique integer value identifying this Car cluster event.

# paths./cluster-events/cars/{id}/.patch.description
Use this method to update car cluster event properties

# paths./cluster-events/cars/{id}/.patch.parameters[].description
A unique integer value identifying this Car cluster event.

# paths./cluster-events/cars/{id}/.delete.description
Use this method to delete car cluster event

# paths./cluster-events/cars/{id}/.delete.parameters[].description
A unique integer value identifying this Car cluster event.

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `body` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/cars/count/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `category` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `color` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/cars/count/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/cars/count/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `license_plate_country` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `license_plate_number_color` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `license_plate_number` contains this substring (case insensitive)

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `license_plate_region` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `make` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `model` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `special_vehicle_type` takes one of these values

# paths./cluster-events/cars/count/.get.parameters[].description
Select objects where feature `weight_type` takes one of these values

# paths./cluster-events/faces/.get.description
Use this method to list face cluster events.

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `age` is greater than or equal than this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `age` is lower than or equal than this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `beard` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/faces/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/faces/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/faces/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/faces/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `emotions` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `gender` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `glasses` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/faces/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `liveness` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `look` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/faces/.get.parameters[].description
Select objects where feature `medmask` takes one of these values

# paths./cluster-events/faces/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./cluster-events/faces/{id}/.get.description
Use this method to retrieve face cluster event by ID

# paths./cluster-events/faces/{id}/.get.parameters[].description
A unique integer value identifying this Face cluster event.

# paths./cluster-events/faces/{id}/.put.description
Use this method to update face cluster event properties

# paths./cluster-events/faces/{id}/.put.parameters[].description
A unique integer value identifying this Face cluster event.

# paths./cluster-events/faces/{id}/.patch.description
Use this method to update face cluster event properties

# paths./cluster-events/faces/{id}/.patch.parameters[].description
A unique integer value identifying this Face cluster event.

# paths./cluster-events/faces/{id}/.delete.description
Use this method to delete face cluster event

# paths./cluster-events/faces/{id}/.delete.parameters[].description
A unique integer value identifying this Face cluster event.

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `age` is greater than or equal than this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `age` is lower than or equal than this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `beard` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects related to this `camera group`

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects related to this `camera`.

# paths./cluster-events/faces/count/.get.parameters[].description
Select cluster events related to these `cases`

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where the `cluster` id takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `emotions` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects related to this `episode`

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `gender` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `glasses` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
`true` - select only cluster events relates to case. `false` - select only cluster events without case.

# paths./cluster-events/faces/count/.get.parameters[].description
`true` - select only cluster events with matches. `false` - select only cluster events without matches.

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `liveness` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `look` takes one of these values

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects that match a card included in these watch lists

# paths./cluster-events/faces/count/.get.parameters[].description
Select objects where feature `medmask` takes one of these values

# paths./clusterization-jobs/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./clusterization-jobs/{id}/.get.parameters[].description
A unique integer value identifying this Clusterization job.

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `age_group` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `gender` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `bottom_color` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/bodies/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/bodies/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `detailed_upper_clothes` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/bodies/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/bodies/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/bodies/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `headwear` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `helmet_type` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `lower_clothes` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/bodies/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `top_color` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `upper_clothes` feature takes one of these values

# paths./clusters/bodies/.get.parameters[].description
Select clusters where `vest_type` feature takes one of these values

# paths./clusters/bodies/{id}/.get.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/{id}/.patch.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/{id}/.delete.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/{id}/contacts/.get.description
This method searches for body clusters with whom the selected body cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `age_group` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `gender` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `bottom_color` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Parameter that determines how many seconds have passed in both directions since contact.

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `detailed_upper_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `headwear` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `helmet_type` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `lower_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `top_color` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `upper_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts/.get.parameters[].description
Select clusters where `vest_type` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.description
This method searches for body clusters with whom the selected body cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/bodies/{id}/contacts_tracks/.get.summary
Search for body cluster contacts using tracks (experimental feature)

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `age_group` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `gender` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `bottom_color` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `detailed_upper_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `headwear` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `helmet_type` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Parameter that determines track intersection threshold in seconds.

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `lower_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `top_color` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `upper_clothes` feature takes one of these values

# paths./clusters/bodies/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `vest_type` feature takes one of these values

# paths./clusters/bodies/{id}/merge/.post.description
This method allows you to merge multiple body clusters.Source clusters besides selected will be deleted.

# paths./clusters/bodies/{id}/merge/.post.summary
Merge multiple body clusters into selected

# paths./clusters/bodies/{id}/merge/.post.parameters[].description
A unique integer value identifying this Body cluster.

# paths./clusters/bodies/count/.get.description
This method retrieves a count of body clusters.

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `age_group` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `gender` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `bottom_color` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `detailed_upper_clothes` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/bodies/count/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/bodies/count/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `headwear` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `helmet_type` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `lower_clothes` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `top_color` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `upper_clothes` feature takes one of these values

# paths./clusters/bodies/count/.get.parameters[].description
Select clusters where `vest_type` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters where `body` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/cars/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/cars/.get.parameters[].description
Select clusters where `category` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters where `color` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/cars/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/cars/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/cars/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/cars/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/cars/.get.parameters[].description
Select clusters where `license_plate_country` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters where `license_plate_number_color` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select cluster where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./clusters/cars/.get.parameters[].description
Select clusters where `license_plate_region` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/cars/.get.parameters[].description
Select clusters where `make` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/cars/.get.parameters[].description
Select clusters where `model` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/cars/.get.parameters[].description
Select clusters where `special_vehicle_type` feature takes one of these values

# paths./clusters/cars/.get.parameters[].description
Select clusters where `weight_type` feature takes one of these values

# paths./clusters/cars/{id}/.get.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/{id}/.patch.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/{id}/.delete.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/{id}/contacts/.get.description
This method searches for car clusters with whom the selected car cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `body` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `category` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `color` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Parameter that determines how many seconds have passed in both directions since contact.

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `license_plate_country` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `license_plate_number_color` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select cluster where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `license_plate_region` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `make` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `model` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `special_vehicle_type` feature takes one of these values

# paths./clusters/cars/{id}/contacts/.get.parameters[].description
Select clusters where `weight_type` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.description
This method searches for car clusters with whom the selected car cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/cars/{id}/contacts_tracks/.get.summary
Search for car cluster contacts using tracks (experimental feature)

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `body` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `category` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `color` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Parameter that determines track intersection threshold in seconds.

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `license_plate_country` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `license_plate_number_color` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select cluster where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `license_plate_region` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `make` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `model` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `special_vehicle_type` feature takes one of these values

# paths./clusters/cars/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `weight_type` feature takes one of these values

# paths./clusters/cars/{id}/merge/.post.description
This method allows you to merge multiple car clusters.Source clusters besides selected will be deleted.

# paths./clusters/cars/{id}/merge/.post.summary
Merge multiple car clusters into selected

# paths./clusters/cars/{id}/merge/.post.parameters[].description
A unique integer value identifying this Car cluster.

# paths./clusters/cars/count/.get.description
This method retrieves a count of car clusters.

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `body` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/cars/count/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `category` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `color` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/cars/count/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/cars/count/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/cars/count/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `license_plate_country` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `license_plate_number_color` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select cluster where the SQL condition `license_plate_number ILIKE license_plate_number_contains` is true

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `license_plate_region` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `make` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `model` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `special_vehicle_type` feature takes one of these values

# paths./clusters/cars/count/.get.parameters[].description
Select clusters where `weight_type` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select clusters where feature `age` is **greater than or equal** than this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where feature `age` is **lower than or equal** than this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where `beard` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/faces/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/faces/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/faces/.get.parameters[].description
Select clusters where `emotions` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/faces/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/faces/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/faces/.get.parameters[].description
Select clusters gender `gender` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select clusters where `glasses` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/faces/.get.parameters[].description
Select clusters where `liveness` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select clusters where `look` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/faces/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/faces/.get.parameters[].description
Select clusters where `medmask` feature takes one of these values

# paths./clusters/faces/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/faces/{id}/.get.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/{id}/.patch.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/{id}/.delete.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/{id}/contacts/.get.description
This method searches for face clusters with whom the selected face cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where feature `age` is **greater than or equal** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where feature `age` is **lower than or equal** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `beard` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Parameter that determines how many seconds have passed in both directions since contact.

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `emotions` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters gender `gender` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `glasses` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `liveness` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `look` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Select clusters where `medmask` feature takes one of these values

# paths./clusters/faces/{id}/contacts/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/faces/{id}/contacts_tracks/.get.description
This method searches for face clusters with whom the selected face cluster has been in contact. All filters from cluster listing are supported.

# paths./clusters/faces/{id}/contacts_tracks/.get.summary
Search for face cluster contacts using tracks (experimental feature)

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where feature `age` is **greater than or equal** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where feature `age` is **lower than or equal** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `beard` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `emotions` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters gender `gender` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `glasses` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Parameter that determines track intersection threshold in seconds.

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `liveness` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `look` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters that contain object similar to: (`detection:<detection id>`, `{face, body or car}event:<event id>`, `{face, body or car}object:<object id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`)

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Select clusters where `medmask` feature takes one of these values

# paths./clusters/faces/{id}/contacts_tracks/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `looks_like_confidence`

# paths./clusters/faces/{id}/merge/.post.description
This method allows you to merge multiple face clusters.Source clusters besides selected will be deleted.

# paths./clusters/faces/{id}/merge/.post.summary
Merge multiple face clusters into selected

# paths./clusters/faces/{id}/merge/.post.parameters[].description
A unique integer value identifying this Face cluster.

# paths./clusters/faces/count/.get.description
This method retrieves a count of face clusters.

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where feature `age` is **greater than or equal** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where feature `age` is **lower than or equal** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `beard` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
Select clusters associated with the specified camera groups

# paths./clusters/faces/count/.get.parameters[].description
Select clusters associated with the specified cameras

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `emotions` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
Select objects related to `episode` Pass comma separated values to select related to multiple `episode`s)

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `any` event date **greater** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `any` event date **greater than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `any` event date **less** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `any` event date **less than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where cluster events count is **greater or equal than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where cluster events count is **less or equal than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where average cluster event quality is **greater or equal than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where average cluster event quality is **less or equal than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `first` event date **greater** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `first` event date **greater than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `first` event date **less** than this value

# paths./clusters/faces/count/.get.parameters[].description
Select objects with `first` event date **less than or equal** to this value

# paths./clusters/faces/count/.get.parameters[].description
Select clusters gender `gender` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `glasses` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
`true` - select only clusters with a card. `false` - select only clusters without a card.

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `liveness` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `look` feature takes one of these values

# paths./clusters/faces/count/.get.parameters[].description
Select clusters that matched a card included in these watch lists

# paths./clusters/faces/count/.get.parameters[].description
Select clusters where `medmask` feature takes one of these values

# paths./config.json.get.description
This method retrieves the web UI configuration.

# paths./counter-records/.get.parameters[].description
Select counter records related to `camera_group`.

# paths./counter-records/.get.parameters[].description
Select counter records related to `camera`.

# paths./counter-records/.get.parameters[].description
Select counter records with `cars_count` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `cars_count` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records related to one or multiple `counter`s

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./counter-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./counter-records/.get.parameters[].description
Select only counter records with (`true`) or without (`false`) errors

# paths./counter-records/.get.parameters[].description
Select counter records with `faces_count` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `faces_count` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counters records with provided ids

# paths./counter-records/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_avg` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_avg` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_max` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_max` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_min` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `proximity_min` **less than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `silhouettes_count` **greater than or equal** to this value

# paths./counter-records/.get.parameters[].description
Select counter records with `silhouettes_count` **less than or equal** to this value

# paths./counter-records/{id}/.get.parameters[].description
A unique integer value identifying this Counter record.

# paths./counter-records/count/.get.parameters[].description
Select counter records related to `camera_group`.

# paths./counter-records/count/.get.parameters[].description
Select counter records related to `camera`.

# paths./counter-records/count/.get.parameters[].description
Select counter records with `cars_count` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `cars_count` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records related to one or multiple `counter`s

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./counter-records/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./counter-records/count/.get.parameters[].description
Select only counter records with (`true`) or without (`false`) errors

# paths./counter-records/count/.get.parameters[].description
Select counter records with `faces_count` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `faces_count` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counters records with provided ids

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_avg` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_avg` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_max` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_max` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_min` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `proximity_min` **less than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `silhouettes_count` **greater than or equal** to this value

# paths./counter-records/count/.get.parameters[].description
Select counter records with `silhouettes_count` **less than or equal** to this value

# paths./counters/.get.description
This method retrieves the list of counters.

# paths./counters/.get.parameters[].description
Select only active counters (`true`) or inactive (`false`) counters

# paths./counters/.get.parameters[].description
Get counters that are associated with cameras from `camera_group`.

# paths./counters/.get.parameters[].description
Get counters that are associated with `camera`. Pass comma separated values to select counters related to multiple `camera`s

# paths./counters/.get.parameters[].description
Select counters with `count_interval` **greater than or equal** to this value

# paths./counters/.get.parameters[].description
Select counters with `count_interval` **less than or equal** to this value

# paths./counters/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./counters/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./counters/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./counters/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./counters/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./counters/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./counters/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./counters/.get.parameters[].description
Select only counters with (`true`) or without (`false`) proximity detection

# paths./counters/.get.parameters[].description
Select counters related to multiple cameras

# paths./counters/.get.parameters[].description
Select counters where the SQL condition `name ILIKE name_contains` is true

# paths./counters/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`

# paths./counters/{id}/.get.description
This method retrieves a counter by its ID.

# paths./counters/{id}/.get.parameters[].description
A unique integer value identifying this Counter.

# paths./counters/{id}/.patch.description
Use this method to update a counter properties.

# paths./counters/{id}/.patch.parameters[].description
A unique integer value identifying this Counter.

# paths./counters/{id}/.delete.parameters[].description
A unique integer value identifying this Counter.

# paths./counters/{id}/proximity_calibration/.post.summary
Start or restart counter proximity calibration

# paths./counters/{id}/proximity_calibration/.post.parameters[].description
Collect calibration track data for this time (in seconds).

# paths./counters/{id}/proximity_calibration/.post.parameters[].description
A unique integer value identifying this Counter.

# paths./counters/{id}/proximity_calibration/.post.parameters[].description
Do not delete existing track data on recalibration

# paths./counters/{id}/proximity_calibration/.delete.summary
Delete counter's proximity calibration data

# paths./counters/{id}/proximity_calibration/.delete.parameters[].description
A unique integer value identifying this Counter.

# paths./counters/count/.get.parameters[].description
Select only active counters (`true`) or inactive (`false`) counters

# paths./counters/count/.get.parameters[].description
Get counters that are associated with cameras from `camera_group`.

# paths./counters/count/.get.parameters[].description
Get counters that are associated with `camera`. Pass comma separated values to select counters related to multiple `camera`s

# paths./counters/count/.get.parameters[].description
Select counters with `count_interval` **greater than or equal** to this value

# paths./counters/count/.get.parameters[].description
Select counters with `count_interval` **less than or equal** to this value

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./counters/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./counters/count/.get.parameters[].description
Select only counters with (`true`) or without (`false`) proximity detection

# paths./counters/count/.get.parameters[].description
Select counters related to multiple cameras

# paths./counters/count/.get.parameters[].description
Select counters where the SQL condition `name ILIKE name_contains` is true

# paths./current-datetime.get.description
Use this method to get server current datetime

# paths./detect.post.description
Use this method to detect objects on a photo

# paths./device-blacklist-records/.get.description
Use this method to list device blacklist records.

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./device-blacklist-records/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records with `expire_date` **greater than or equal** to this value

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records with `expire_date` **greater than or equal** to this value

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records with provided ids

# paths./device-blacklist-records/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records where the SQL condition `reason ILIKE reason_contains` is true

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records where the SQL condition `uuid ILIKE uuid_contains` is true

# paths./device-blacklist-records/.get.parameters[].description
Select device blacklist records related to one or multiple `uuid`s

# paths./device-blacklist-records/.post.description
Use this method to add a device blacklist record.

# paths./device-blacklist-records/{id}/.get.description
Use this method to retrieve a device blacklist record.

# paths./device-blacklist-records/{id}/.get.parameters[].description
A unique integer value identifying this Device blacklist record.

# paths./device-blacklist-records/{id}/.patch.description
Use this method to update a device blacklist record properties.

# paths./device-blacklist-records/{id}/.patch.summary
Update device blacklist record properties

# paths./device-blacklist-records/{id}/.patch.parameters[].description
A unique integer value identifying this Device blacklist record.

# paths./device-blacklist-records/{id}/.delete.description
Use this method to delete a device blacklist record.

# paths./device-blacklist-records/{id}/.delete.parameters[].description
A unique integer value identifying this Device blacklist record.

# paths./episodes/cars/.get.parameters[].description
Select only acknowledged episodes (`true`) or unacknowledged (`false`) episodes

# paths./episodes/cars/.get.parameters[].description
Select only episodes with this acknowledgment reaction

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `body` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes associated with the specified camera groups

# paths./episodes/cars/.get.parameters[].description
Select episodes associated with the specified cameras

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `category` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes with `closed_date` **greater than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `color` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./episodes/cars/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./episodes/cars/.get.parameters[].description
Select episodes with number of events is **greater or equal than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
`true` - select only episodes relates to case. `false` - select only episodes without case.

# paths./episodes/cars/.get.parameters[].description
Select only the episode with the last car event of the given id

# paths./episodes/cars/.get.parameters[].description
Select episodes with `last_car_event_date` **greater than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where best event latitude **greater than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where best event latitude **less than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `license_plate_country` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `license_plate_number_color` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `license_plate_number` contains this value (case-insensitive)

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `license_plate_region` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes where best event longitude **greater than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where best event longitude **less than or equal** to this value

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `make` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes associated with the specified watch lists

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `model` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select only episodes without matched car (`true`) or with matched car (`false`)

# paths./episodes/cars/.get.parameters[].description
Select only open episodes (`true`) or closed (`false`) episodes

# paths./episodes/cars/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`, `uniform`

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `special_vehicle_type` takes one of these values

# paths./episodes/cars/.get.parameters[].description
Select episodes associated with the specified video archives

# paths./episodes/cars/.get.parameters[].description
Select episodes where feature `weight_type` takes one of these values

# paths./episodes/cars/{id}/.get.description
Use this method to retrieve car episode by its ID.

# paths./episodes/cars/{id}/.get.parameters[].description
A unique integer value identifying this Car episode.

# paths./episodes/cars/{id}/.patch.description
Use this method to update car episode properties.

# paths./episodes/cars/{id}/.patch.parameters[].description
A unique integer value identifying this Car episode.

# paths./episodes/cars/count/.get.parameters[].description
Select only acknowledged episodes (`true`) or unacknowledged (`false`) episodes

# paths./episodes/cars/count/.get.parameters[].description
Select only episodes with this acknowledgment reaction

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `body` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes associated with the specified camera groups

# paths./episodes/cars/count/.get.parameters[].description
Select episodes associated with the specified cameras

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `category` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes with `closed_date` **greater than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `color` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./episodes/cars/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./episodes/cars/count/.get.parameters[].description
Select episodes with number of events is **greater or equal than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
`true` - select only episodes relates to case. `false` - select only episodes without case.

# paths./episodes/cars/count/.get.parameters[].description
Select only the episode with the last car event of the given id

# paths./episodes/cars/count/.get.parameters[].description
Select episodes with `last_car_event_date` **greater than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where best event latitude **greater than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where best event latitude **less than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `license_plate_country` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `license_plate_number_color` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `license_plate_number` contains this value (case-insensitive)

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `license_plate_region` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where best event longitude **greater than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where best event longitude **less than or equal** to this value

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `make` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes associated with the specified watch lists

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `model` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select only episodes without matched car (`true`) or with matched car (`false`)

# paths./episodes/cars/count/.get.parameters[].description
Select only open episodes (`true`) or closed (`false`) episodes

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `special_vehicle_type` takes one of these values

# paths./episodes/cars/count/.get.parameters[].description
Select episodes associated with the specified video archives

# paths./episodes/cars/count/.get.parameters[].description
Select episodes where feature `weight_type` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select only acknowledged episodes (`true`) or unacknowledged (`false`) episodes

# paths./episodes/humans/.get.parameters[].description
Select only episodes with this acknowledgment reaction

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `age_group` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature`age` is **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `age` is **lower than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `bag_back` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `bag_ground` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `bag_hand` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `beard` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `gender` takes one of these values(body feature)

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `bottom_color` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes associated with the specified camera groups

# paths./episodes/humans/.get.parameters[].description
Select episodes associated with the specified cameras

# paths./episodes/humans/.get.parameters[].description
Select episodes with `closed_date` **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./episodes/humans/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `detailed_upper_clothes` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `emotions` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes with number of events is **greater or equal than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `eyes_attrs` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `fall` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `gender` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `glasses` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `handface_phone_call` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `handface_phone_use` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `handface_smoking` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `handface_taking_pictures` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select only episodes with body (`true`) or without body (`false`)

# paths./episodes/humans/.get.parameters[].description
`true` - select only episodes relates to case. `false` - select only episodes without case.

# paths./episodes/humans/.get.parameters[].description
Select only episodes with face (`true`) or without face (`false`)

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `headwear` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `helmet_type` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `helmet_type_score` is **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `helmet_type_score` is **lower than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select only the episode with the last body event of the given id

# paths./episodes/humans/.get.parameters[].description
Select episodes with `last_body_event_date` **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select only the episode with the last face event of the given id

# paths./episodes/humans/.get.parameters[].description
Select episodes with `last_face_event_date` **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where best event latitude **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where best event latitude **less than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `liveness` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where best event longitude **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where best event longitude **less than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `look` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `lower_clothes` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes associated with the specified watch lists

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `medmask` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select only episodes without matched body (`true`) or with matched body (`false`)

# paths./episodes/humans/.get.parameters[].description
Select only episodes without matched face (`true`) or with matched face (`false`)

# paths./episodes/humans/.get.parameters[].description
Select only open episodes (`true`) or closed (`false`) episodes

# paths./episodes/humans/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`, `uniform`

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `top_color` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `upper_clothes` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `vest_type` takes one of these values

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `vest_type_score` is **greater than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes where feature `vest_type_score` is **lower than or equal** to this value

# paths./episodes/humans/.get.parameters[].description
Select episodes associated with the specified video archives

# paths./episodes/humans/{id}/.get.description
Use this method to retrieve human episode by its ID.

# paths./episodes/humans/{id}/.get.parameters[].description
A unique integer value identifying this Human episode.

# paths./episodes/humans/{id}/.patch.description
Use this method to update human episode properties.

# paths./episodes/humans/{id}/.patch.parameters[].description
A unique integer value identifying this Human episode.

# paths./episodes/humans/count/.get.parameters[].description
Select only acknowledged episodes (`true`) or unacknowledged (`false`) episodes

# paths./episodes/humans/count/.get.parameters[].description
Select only episodes with this acknowledgment reaction

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `age_group` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature`age` is **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `age` is **lower than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `bag_back` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `bag_ground` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `bag_hand` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `beard` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `gender` takes one of these values(body feature)

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `bottom_color` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes associated with the specified camera groups

# paths./episodes/humans/count/.get.parameters[].description
Select episodes associated with the specified cameras

# paths./episodes/humans/count/.get.parameters[].description
Select episodes with `closed_date` **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./episodes/humans/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `detailed_upper_clothes` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `emotions` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes with number of events is **greater or equal than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `eyes_attrs` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `fall` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `gender` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `glasses` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `handface_phone_call` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `handface_phone_use` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `handface_smoking` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `handface_taking_pictures` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select only episodes with body (`true`) or without body (`false`)

# paths./episodes/humans/count/.get.parameters[].description
`true` - select only episodes relates to case. `false` - select only episodes without case.

# paths./episodes/humans/count/.get.parameters[].description
Select only episodes with face (`true`) or without face (`false`)

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `headwear` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `helmet_type` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `helmet_type_score` is **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `helmet_type_score` is **lower than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select only the episode with the last body event of the given id

# paths./episodes/humans/count/.get.parameters[].description
Select episodes with `last_body_event_date` **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select only the episode with the last face event of the given id

# paths./episodes/humans/count/.get.parameters[].description
Select episodes with `last_face_event_date` **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where best event latitude **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where best event latitude **less than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `liveness` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where best event longitude **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where best event longitude **less than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `look` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `lower_clothes` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes associated with the specified watch lists

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `medmask` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select only episodes without matched body (`true`) or with matched body (`false`)

# paths./episodes/humans/count/.get.parameters[].description
Select only episodes without matched face (`true`) or with matched face (`false`)

# paths./episodes/humans/count/.get.parameters[].description
Select only open episodes (`true`) or closed (`false`) episodes

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `top_color` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `upper_clothes` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `vest_type` takes one of these values

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `vest_type_score` is **greater than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes where feature `vest_type_score` is **lower than or equal** to this value

# paths./episodes/humans/count/.get.parameters[].description
Select episodes associated with the specified video archives

# paths./events/bodies/.get.parameters[].description
`true` - select only acknowledged events (do not require acknowledgement), `false` - select only unacknowledged events

# paths./events/bodies/.get.parameters[].description
Select events where `features.age_group.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.age_group.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.age_group.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
`true` - select only events with backward intersected line. `false` - select only events intersected line in one direction.

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_back.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_back.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_back.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_ground.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_ground.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_ground.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_hand.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_hand.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bag_hand.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.gender.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.top_color.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.bottom_color.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.bottom_color.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select objects where `bs_type` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select objects with created in last N days

# paths./events/bodies/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select objects with created in last Nth week (including Sunday and Saturday)

# paths./events/bodies/.get.parameters[].description
Select objects with created in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./events/bodies/.get.parameters[].description
Select events where `features.detailed_upper_clothes.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.detailed_upper_clothes.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.detailed_upper_clothes.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events that created by external detectors

# paths./events/bodies/.get.parameters[].description
Select events where `features.fall.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.fall.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.fall.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.gender.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.gender.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_call.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_call.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_call.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_use.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_use.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_phone_use.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_smoking.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_smoking.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_smoking.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_taking_pictures.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_taking_pictures.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.handface_taking_pictures.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
`true` - select only events relates to case. `false` - select only events without case.

# paths./events/bodies/.get.parameters[].description
Select events where `features.headwear.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.headwear.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.headwear.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.helmet_type.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.helmet_type.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.helmet_type.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select objects with `id` **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `latitude` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `latitude` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events that intersects with this lines

# paths./events/bodies/.get.parameters[].description
Select events that intersect line in these directions

# paths./events/bodies/.get.parameters[].description
Select events where `longitude` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `longitude` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events with faces similar to: (`detection:<detection id>`, `{face, body or car}object:<object id>`, `{face, body or car}event:<event id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`). You can pass several search sources to search for. Pagination works if there is only one face to search for and if the sorting order is id. In all other cases, only the first page of results is returned

# paths./events/bodies/.get.parameters[].description
Select events where `features.lower_clothes.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.lower_clothes.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.lower_clothes.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events that match a card included in these watch lists

# paths./events/bodies/.get.parameters[].description
`true` - select only events without matches. `false` - select events only with matches.

# paths./events/bodies/.get.parameters[].description
Which field to use for ordering. Available values: id, -id. Available values for looks_like: -confidence, -looks_like_confidence, id, -id, confidence and looks_like_confidence ordering are equivalents

# paths./events/bodies/.get.parameters[].description
Select events where `features.top_color.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.top_color.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.top_color.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.upper_clothes.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.upper_clothes.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.upper_clothes.confidence` is **less than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.vest_type.name` takes one of these values

# paths./events/bodies/.get.parameters[].description
Select events where `features.vest_type.confidence` is **greater than or equal** to this value

# paths./events/bodies/.get.parameters[].description
Select events where `features.vest_type.confidence` is **less than or equal** to this value

# paths./events/bodies/{id}/.patch.description
Use this method to update body event properties.

# paths./events/bodies/acknowledge/.post.description
Use this method to acknowledge all events of this object type accessible for the current user.

# paths./events/bodies/acknowledge/.post.summary
Acknowledge all events of this type accessible for the current user

# paths./events/bodies/add/.post.description
Use this method to create new body events.

# paths./events/cars/.get.parameters[].description
`true` - select only acknowledged events (do not require acknowledgement), `false` - select only unacknowledged events

# paths./events/cars/.get.parameters[].description
`true` - select only events with backward intersected line. `false` - select only events intersected line in one direction.

# paths./events/cars/.get.parameters[].description
Select events where `features.body.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.body.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.body.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select objects where `bs_type` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.category.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.category.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.category.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.color.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.color.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.color.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select objects with created in last N days

# paths./events/cars/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select objects with created in last Nth week (including Sunday and Saturday)

# paths./events/cars/.get.parameters[].description
Select objects with created in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./events/cars/.get.parameters[].description
Select events that created by external detectors

# paths./events/cars/.get.parameters[].description
`true` - select only events relates to case. `false` - select only events without case.

# paths./events/cars/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select objects with `id` **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `latitude` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `latitude` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_country.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_country.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_country.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_number_color` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_number_color.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_number_color.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_number.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_number.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_region.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_region.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.license_plate_region.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events that intersects with this lines

# paths./events/cars/.get.parameters[].description
Select events that intersect line in these directions

# paths./events/cars/.get.parameters[].description
Select events where `longitude` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `longitude` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events with faces similar to: (`detection:<detection id>`, `{face, body or car}object:<object id>`, `{face, body or car}event:<event id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`). You can pass several search sources to search for. Pagination works if there is only one face to search for and if the sorting order is id. In all other cases, only the first page of results is returned

# paths./events/cars/.get.parameters[].description
Select events where `features.make.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.make.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.make.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events that match a card included in these watch lists

# paths./events/cars/.get.parameters[].description
Select events where `features.model.name` contains provided string(case insensitive)

# paths./events/cars/.get.parameters[].description
Select events where `features.model.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.model.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
`true` - select only events without matches. `false` - select events only with matches.

# paths./events/cars/.get.parameters[].description
Which field to use for ordering. Available values: id, -id. Available values for looks_like: -confidence, -looks_like_confidence, id, -id, confidence and looks_like_confidence ordering are equivalents

# paths./events/cars/.get.parameters[].description
Select events where `features.orientation.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.orientation.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.orientation.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.special_vehicle_type.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.special_vehicle_type.confidence` is **less than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.weight_type.name` takes one of these values

# paths./events/cars/.get.parameters[].description
Select events where `features.weight_type.confidence` is **greater than or equal** to this value

# paths./events/cars/.get.parameters[].description
Select events where `features.weight_type.confidence` is **less than or equal** to this value

# paths./events/cars/{id}/.patch.description
Use this method to update car event properties.

# paths./events/cars/acknowledge/.post.description
Use this method to acknowledge all events of this object type accessible for the current user.

# paths./events/cars/acknowledge/.post.summary
Acknowledge all events of this type accessible for the current user

# paths./events/cars/add/.post.description
Use this method to create new car events.

# paths./events/faces/.get.parameters[].description
`true` - select only acknowledged events (do not require acknowledgement), `false` - select only unacknowledged events

# paths./events/faces/.get.parameters[].description
Select events where `features.age` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.age` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
`true` - select only events with backward intersected line. `false` - select only events intersected line in one direction.

# paths./events/faces/.get.parameters[].description
Select events where `features.beard.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.beard.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.beard.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select objects where `bs_type` takes one of these values

# paths./events/faces/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select objects with created in last N days

# paths./events/faces/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select objects with created in last Nth week (including Sunday and Saturday)

# paths./events/faces/.get.parameters[].description
Select objects with created in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./events/faces/.get.parameters[].description
Select events where `features.emotions.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.emotions.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.emotions.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events that created by external detectors

# paths./events/faces/.get.parameters[].description
Select events where `features.eyes_attrs.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.eyes_attrs.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.eyes_attrs.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.gender.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.gender.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.gender.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.glasses.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.glasses.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.glasses.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
`true` - select only events relates to case. `false` - select only events without case.

# paths./events/faces/.get.parameters[].description
Select events where `features.headpose.pitch` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.headpose.pitch` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.headpose.yaw` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.headpose.yaw` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select objects with `id` **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select objects with `id` **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `latitude` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `latitude` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events that intersects with this lines

# paths./events/faces/.get.parameters[].description
Select events that intersect line in these directions

# paths./events/faces/.get.parameters[].description
Select events where `features.liveness.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.liveness.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.liveness.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `longitude` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `longitude` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.look.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.look.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.look.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events with faces similar to: (`detection:<detection id>`, `{face, body or car}object:<object id>`, `{face, body or car}event:<event id>`, `{face, body or car}cluster:<cluster id>` or `casecluster:<casecluster id>`). You can pass several search sources to search for. Pagination works if there is only one face to search for and if the sorting order is id. In all other cases, only the first page of results is returned

# paths./events/faces/.get.parameters[].description
Select events that match a card included in these watch lists

# paths./events/faces/.get.parameters[].description
Select events where `features.medmask.name` takes one of these values

# paths./events/faces/.get.parameters[].description
Select events where `features.medmask.confidence` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `features.medmask.confidence` is **less than or equal** to this value

# paths./events/faces/.get.parameters[].description
`true` - select only events without matches. `false` - select events only with matches.

# paths./events/faces/.get.parameters[].description
Which field to use for ordering. Available values: id, -id. Available values for looks_like: -confidence, -looks_like_confidence, id, -id, confidence and looks_like_confidence ordering are equivalents

# paths./events/faces/.get.parameters[].description
Select events where `temperature` is **greater than or equal** to this value

# paths./events/faces/.get.parameters[].description
Select events where `temperature` is **less than or equal** to this value

# paths./events/faces/{id}/.patch.description
Use this method to update face event properties.

# paths./events/faces/acknowledge/.post.description
Use this method to acknowledge all events of this object type accessible for the current user.

# paths./events/faces/acknowledge/.post.summary
Acknowledge all events of this type accessible for the current user

# paths./events/faces/add/.post.description
Use this method to create new face events.

# paths./geocoding/reverse/.get.description
Use this method to reverse search geocoding info

# paths./geocoding/reverse/.get.parameters[].description
Latitude to converting to human-readable address

# paths./geocoding/reverse/.get.parameters[].description
Longitude to converting to human-readable address

# paths./geocoding/search/.get.description
Use this method to search geocoding info

# paths./groups/.get.description
This method retrieves the list of group objects.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./groups/.post.description
This method creates a groups object.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/{id}/.get.description
This method retrieves group object by id.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/{id}/.get.parameters[].description
A unique integer value identifying this group.

# paths./groups/{id}/.put.description
This method replaces group object.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/{id}/.put.parameters[].description
A unique integer value identifying this group.

# paths./groups/{id}/.patch.description
This method updates group object.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/{id}/.patch.parameters[].description
A unique integer value identifying this group.

# paths./groups/{id}/.delete.description
This method deletes group object.
 **Groups** are objects used to control access to the system entities, such as watch lists, camera groups, etc.

# paths./groups/{id}/.delete.parameters[].description
A unique integer value identifying this group.

# paths./hooks/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./hooks/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./hooks/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./hooks/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./hooks/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./hooks/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./hooks/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./hooks/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `name`, `url`, `active`

# paths./hooks/{id}/.get.description
Use this method to retrieve a webhook by its ID.

# paths./hooks/{id}/.get.parameters[].description
A unique integer value identifying this Webhook.

# paths./hooks/{id}/.patch.description
Use this method to update a webhook properties.

# paths./hooks/{id}/.patch.parameters[].description
A unique integer value identifying this Webhook.

# paths./hooks/{id}/.delete.parameters[].description
A unique integer value identifying this Webhook.

# paths./human-card-attachments/.get.parameters[].description
Select attachments related to `human card`

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./human-card-attachments/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./human-card-attachments/{id}/.get.parameters[].description
A unique integer value identifying this Human card attachment.

# paths./human-card-attachments/{id}/.put.parameters[].description
A unique integer value identifying this Human card attachment.

# paths./human-card-attachments/{id}/.patch.parameters[].description
A unique integer value identifying this Human card attachment.

# paths./human-card-attachments/{id}/.delete.parameters[].description
A unique integer value identifying this Human card attachment.

# paths./lines/.get.parameters[].description
Select only active lines (`true`) or inactive (`false`) lines

# paths./lines/.get.parameters[].description
Get lines from `cameras` or `video_archives` from these `camera_groups`

# paths./lines/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./lines/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./lines/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./lines/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./lines/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./lines/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./lines/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./lines/.get.parameters[].description
Select lines where the SQL condition `name ILIKE name_contains` is true

# paths./lines/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./lines/{id}/.get.parameters[].description
A unique integer value identifying this Line.

# paths./lines/{id}/.patch.parameters[].description
A unique integer value identifying this Line.

# paths./lines/{id}/.delete.parameters[].description
A unique integer value identifying this Line.

# paths./lines/attributes/.get.description
This method retrieves all used attributes of lines.

# paths./lines/count/.get.parameters[].description
Select only active lines (`true`) or inactive (`false`) lines

# paths./lines/count/.get.parameters[].description
Get lines from `cameras` or `video_archives` from these `camera_groups`

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./lines/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./lines/count/.get.parameters[].description
Select lines where the SQL condition `name ILIKE name_contains` is true

# paths./meta-dictionaries/.get.description
Use this method to list meta dictionaries.

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./meta-dictionaries/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./meta-dictionaries/.get.parameters[].description
Select dictionaries where SQL condition `name ILIKE name_contains` is true

# paths./meta-dictionaries/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created_date`, `id`, `modified_date`

# paths./meta-dictionaries/.post.description
Use this method to add a new meta dictionary.

# paths./meta-dictionaries/{id}/.get.description
Use this method to retrieve a meta dictionary.

# paths./meta-dictionaries/{id}/.get.parameters[].description
A unique value identifying this Meta dictionary.

# paths./meta-dictionaries/{id}/.patch.description
Use this method to update a meta dictionary properties.

# paths./meta-dictionaries/{id}/.patch.parameters[].description
A unique value identifying this Meta dictionary.

# paths./meta-dictionaries/{id}/.delete.description
Use this method to delete a meta dictionary.

# paths./meta-dictionaries/{id}/.delete.parameters[].description
A unique value identifying this Meta dictionary.

# paths./meta-dictionary-values/.get.description
Use this method to list a meta dictionary values.

# paths./meta-dictionary-values/.get.parameters[].description
Select values belonging to this `dictionary`

# paths./meta-dictionary-values/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./meta-dictionary-values/.get.parameters[].description
Select elements where the SQL condition `value ILIKE value_contains` is true

# paths./meta-dictionary-values/.post.description
Use this method to add a new meta dictionary value.

# paths./meta-dictionary-values/{id}/.get.description
Use this method to retrieve a meta dictionary value by its ID.

# paths./meta-dictionary-values/{id}/.get.parameters[].description
A unique integer value identifying this Meta dictionary value.

# paths./meta-dictionary-values/{id}/.patch.description
Use this method to update a meta dictionary value.

# paths./meta-dictionary-values/{id}/.patch.parameters[].description
A unique integer value identifying this Meta dictionary value.

# paths./meta-dictionary-values/{id}/.delete.description
Use this method to delete a meta dictionary value.

# paths./meta-dictionary-values/{id}/.delete.parameters[].description
A unique integer value identifying this Meta dictionary value.

# paths./notifications/.get.parameters[].description
Select notifications acknowledged by user

# paths./notifications/.get.parameters[].description
Select notifications with `acknowledged_date` **greater than or equal** to this value

# paths./notifications/.get.parameters[].description
Select only notifications with this acknowledgement reaction

# paths./notifications/.get.parameters[].description
Select only active (`true`) or closed (`false`) notifications

# paths./notifications/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./notifications/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./notifications/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./notifications/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./notifications/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./notifications/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./notifications/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./notifications/.get.parameters[].description
Select notifications on the event with the specified id

# paths./notifications/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./notifications/{id}/.get.description
Use this method to retrieve a notification by its ID.

# paths./notifications/{id}/.get.parameters[].description
A unique integer value identifying this Notification.

# paths./notifications/{id}/acknowledge/.post.parameters[].description
A unique integer value identifying this Notification.

# paths./objects/bodies/.get.description
This method lists body objects.
 **Body object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/bodies/.get.parameters[].description
Select only active objects (`true`) or inactive (`false`)

# paths./objects/bodies/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./objects/bodies/.post.description
This method creates new body object.
 **Body object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/bodies/{id}/.get.description
This method retrieve body object by id.
 **Body object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/bodies/{id}/.patch.description
This method updates a body object properties.

# paths./objects/bodies/{id}/.delete.description
Use this method to delete a body object.

# paths./objects/cars/.get.description
This method lists car objects.
 **Car object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/cars/.get.parameters[].description
Select only active objects (`true`) or inactive (`false`)

# paths./objects/cars/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./objects/cars/.post.description
This method creates new car object.
 **Car object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/cars/{id}/.get.description
This method retrieve car object by id.
 **Car object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/cars/{id}/.patch.description
This method updates a car object properties.

# paths./objects/faces/.get.description
This method lists face objects.
 **Face object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/faces/.get.parameters[].description
Select only active objects (`true`) or inactive (`false`)

# paths./objects/faces/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./objects/faces/.post.description
This method creates new face object.
 **Face object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/faces/{id}/.get.description
This method retrieve face object by id.
 **Face object** is an object that contains source photo, thumbnail, and other attributes

# paths./objects/faces/{id}/.patch.description
This method updates a face object properties.

# paths./objects/faces/{id}/.delete.description
Use this method to delete a face object.

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./onvif-cameras/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./onvif-cameras/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./onvif-cameras/{id}/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/.patch.description
Use this method to update ONVIF Camera properties.

# paths./onvif-cameras/{id}/.patch.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/auth/.post.description
Use this method to auth in ONVIF device.

# paths./onvif-cameras/{id}/auth/.post.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/compatible-video-encoder-configurations/.get.description
This operation lists all the video encoder configurations of ONVIF device that are compatible with a certain media profile.

# paths./onvif-cameras/{id}/compatible-video-encoder-configurations/.get.summary
Get compatible video encoder configurations of ONVIF device

# paths./onvif-cameras/{id}/compatible-video-encoder-configurations/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/compatible-video-source-configurations/.get.description
This operation requests all the video source configurations of the ONVIF device that are compatible with a certain media profile.

# paths./onvif-cameras/{id}/compatible-video-source-configurations/.get.summary
Get compatible video source configurations for profile of ONVIF device

# paths./onvif-cameras/{id}/compatible-video-source-configurations/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/imaging-settings/.get.description
This operation requests the imaging setting for a video source on the device. A device implementing the imaging service shall support this command.

# paths./onvif-cameras/{id}/imaging-settings/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/imaging-settings/.patch.description
This operation sets the imaging settings for a video source on a device. A device implementing the imaging service shall support this command.

# paths./onvif-cameras/{id}/imaging-settings/.patch.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/imaging-settings-options/.get.summary
Get image-settings options of ONVIF device

# paths./onvif-cameras/{id}/imaging-settings-options/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/reboot/.post.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/refresh/.post.description
Use this method to refresh info of ONVIF device.

# paths./onvif-cameras/{id}/refresh/.post.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/start-streaming/.post.description
Use this method to start streaming on ONVIF device.

# paths./onvif-cameras/{id}/start-streaming/.post.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/stop-streaming/.post.description
Use this method to stop streaming on ONVIF device.

# paths./onvif-cameras/{id}/stop-streaming/.post.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/stream-uri/.get.description
Use this method get stream URI from ONVIF device.

# paths./onvif-cameras/{id}/stream-uri/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-encoder-configurations/.get.description
This operation lists all existing video encoder configurations of ONVIF device.

# paths./onvif-cameras/{id}/video-encoder-configurations/.get.summary
Get video encoder configurations of ONVIF device

# paths./onvif-cameras/{id}/video-encoder-configurations/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-encoder-configurations/.patch.description
This operation modifies a video encoder configuration.

# paths./onvif-cameras/{id}/video-encoder-configurations/.patch.summary
Update video encoder configurations of ONVIF device

# paths./onvif-cameras/{id}/video-encoder-configurations/.patch.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-encoder-configurations-options/.get.description
This operation returns the available options when the video encoder parameters are reconfigured.

# paths./onvif-cameras/{id}/video-encoder-configurations-options/.get.summary
Get video encoder configurations options of ONVIF device

# paths./onvif-cameras/{id}/video-encoder-configurations-options/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-source-configurations/.get.description
This operation lists all existing video source configurations for ONVIF device

# paths./onvif-cameras/{id}/video-source-configurations/.get.summary
Get video source configurations of ONVIF device

# paths./onvif-cameras/{id}/video-source-configurations/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-source-configurations/.patch.description
This operation modifies a video source configuration.

# paths./onvif-cameras/{id}/video-source-configurations/.patch.summary
Update video source configurations of ONVIF device

# paths./onvif-cameras/{id}/video-source-configurations/.patch.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./onvif-cameras/{id}/video-source-configurations-options/.get.description
This operation returns the available options when the video source parameters are reconfigured

# paths./onvif-cameras/{id}/video-source-configurations-options/.get.summary
Get available options for video sources configurations of ONVIF device

# paths./onvif-cameras/{id}/video-source-configurations-options/.get.parameters[].description
A unique integer value identifying this Onvif camera.

# paths./permissions/.get.description
Use this method to list all permissions in the system.

# paths./permissions/{id}/.get.description
Use this method to retrieve a permission info by its ID.

# paths./permissions/{id}/.get.parameters[].description
A unique integer value identifying this permission.

# paths./permissions/camera-groups/.get.description
Use this method to list camera groups permissions.

# paths./permissions/camera-groups/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./permissions/camera-groups/{id}/.get.parameters[].description
A unique integer value identifying this Camera groups.

# paths./permissions/camera-groups/{id}/.patch.parameters[].description
A unique integer value identifying this Camera groups.

# paths./permissions/watch-lists/.get.description
Use this method to list watch lists permissions.

# paths./permissions/watch-lists/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./permissions/watch-lists/{id}/.get.description
Use this method to retrieve a watch list permissions by its ID.

# paths./permissions/watch-lists/{id}/.get.parameters[].description
A unique integer value identifying this Watch list.

# paths./permissions/watch-lists/{id}/.patch.description
Use this method to update a watch list permissions.

# paths./permissions/watch-lists/{id}/.patch.parameters[].description
A unique integer value identifying this Watch list.

# paths./reports/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./reports/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./reports/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./reports/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./reports/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./reports/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./reports/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./reports/.get.parameters[].description
Select reports where the SQL condition `name ILIKE name_contains` is true

# paths./reports/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `modified_date`, `size`

# paths./reports/{id}/.get.description
Use this method to retrieve a report by its ID.

# paths./reports/{id}/.get.parameters[].description
A unique integer value identifying this Report.

# paths./reports/{id}/.put.description
Use this method to update a report properties.

# paths./reports/{id}/.put.parameters[].description
A unique integer value identifying this Report.

# paths./reports/{id}/.patch.description
Use this method to update a report properties.

# paths./reports/{id}/.patch.parameters[].description
A unique integer value identifying this Report.

# paths./reports/{id}/.delete.parameters[].description
A unique integer value identifying this Report.

# paths./reports/{id}/restart/.post.description
Use this method to restart report processing.

# paths./reports/{id}/restart/.post.parameters[].description
A unique integer value identifying this Report.

# paths./reports/upload/.post.description
Use this method to upload custom reports.

# paths./sessions/.get.parameters[].description
Select only active (`true`) or inactive (`false`) sessions. Inactive sessions appear only if `face_and_password` authentication is set

# paths./sessions/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./sessions/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./sessions/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./sessions/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./sessions/.get.parameters[].description
Select sessions with `ip` in these **subnets** / **IP addresses** (both supported)

# paths./sessions/.get.parameters[].description
Select only mobile (`true`) or desktop (`false`) sessions

# paths./sessions/.get.parameters[].description
Which field to use when ordering the results. Available fields: `created`, `last_ping_date`, `mobile`, `status`, `user__username`

# paths./sessions/.get.parameters[].description
Select sessions related to users with provided `id`s

# paths./sessions/.get.parameters[].description
Select sessions related to users with provided `user_name`s

# paths./sessions/.get.parameters[].description
Select sessions related to one or multiple `uuid`s

# paths./sessions/{id}/.get.description
Use this method to retrieve an auth session by ID.

# paths./sessions/{id}/.get.parameters[].description
A unique value identifying this ff sec auth session.

# paths./sessions/{id}/.delete.parameters[].description
A unique value identifying this ff sec auth session.

# paths./sessions/delete/.post.description
Use this method to delete multiple auth sessions with provided ids

# paths./settings.get.description
Use this method to retrieve the FindFace Multi settings.

# paths./settings.patch.description
Use this method to update the FindFace Multi settings.

# paths./swagger.json.get.description
OpenApi3 schema for this API. Format can be selected via content negotiation.

- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json

# paths./tracks/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./tracks/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./tracks/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./tracks/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./tracks/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./tracks/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./tracks/.get.parameters[].description
Select only the track of event with provided id

# paths./tracks/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`

# paths./tracks/{id}/.get.parameters[].description
A unique integer value identifying this Track.

# paths./user-face/.get.description
This method allows to get list of user-face objects.
 **User-face** is an object that contains source photo, thumbnail, etc

# paths./user-face/.get.parameters[].description
Select only active objects (`true`) or inactive (`false`)

# paths./user-face/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`

# paths./user-face/.post.description
This method allows to create a user-face object.
 **User-face** is an object that contains source photo, thumbnail, etc

# paths./user-face/{id}/.get.description
This method allows to get a user-face object by id.
 **User-face** is an object that contains source photo, thumbnail, etc

# paths./users/.get.parameters[].description
Select only active users (`true`) or inactive (`false`) users

# paths./users/.get.parameters[].description
Select objects with `date_joined` **greater** than this value

# paths./users/.get.parameters[].description
Select objects with `date_joined` **greater than or equal** to this value

# paths./users/.get.parameters[].description
Select objects with `date_joined` **less** than this value

# paths./users/.get.parameters[].description
Select objects with `date_joined` **less than or equal** to this value

# paths./users/.get.parameters[].description
Select only users with uploaded image (`true`) or without an image (`false`)

# paths./users/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `date_joined`, `modified_date`, `username`, `first_name`, `last_name`, `primary_group`, `is_active`

# paths./users/.get.parameters[].description
Select users whose primary group is this group. 

# paths./users/.get.parameters[].description
Select users where the SQL condition `real_name ILIKE real_name_contains` is true

# paths./users/.get.parameters[].description
Select users where the SQL condition `username ILIKE username_contains` is true

# paths./users/{id}/.get.description
Use this method to retrieve information on the current user.

# paths./users/{id}/.get.parameters[].description
A unique integer value identifying this User.

# paths./users/{id}/.patch.parameters[].description
A unique integer value identifying this User.

# paths./users/{id}/.delete.parameters[].description
A unique integer value identifying this User.

# paths./users/count/.get.parameters[].description
Select only active users (`true`) or inactive (`false`) users

# paths./users/count/.get.parameters[].description
Select objects with `date_joined` **greater** than this value

# paths./users/count/.get.parameters[].description
Select objects with `date_joined` **greater than or equal** to this value

# paths./users/count/.get.parameters[].description
Select objects with `date_joined` **less** than this value

# paths./users/count/.get.parameters[].description
Select objects with `date_joined` **less than or equal** to this value

# paths./users/count/.get.parameters[].description
Select only users with uploaded image (`true`) or without an image (`false`)

# paths./users/count/.get.parameters[].description
Select users whose primary group is this group. 

# paths./users/count/.get.parameters[].description
Select users where the SQL condition `real_name ILIKE real_name_contains` is true

# paths./users/count/.get.parameters[].description
Select users where the SQL condition `username ILIKE username_contains` is true

# paths./verify.get.description
Compare two objects from different sources or object with a object within the same card and return the similarity between them.

# paths./verify.get.summary
Compare two objects or object with object inside card and return similarity

# paths./verify.get.parameters[].description
This field accepts the id of the card that holds object to compare.

# paths./verify.get.parameters[].description
This field can contain one of the following references:
- `detection:<detection id>` - use a `Detection` object
- `faceevent:<event id>` - use `FaceEvent`
- `carevent:<event id>` - use `CarEvent`
- `bodyevent:<event id>` - use `BodyEvent`
- `faceobject:<face id>` - use `FaceObject`
- `carobject:<face id>` - use `CarObject`
- `bodyobject:<face id>` - use `BodyObject`

# paths./videos/.get.parameters[].description
Select videos included in these camera groups

# paths./videos/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./videos/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./videos/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./videos/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./videos/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./videos/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./videos/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./videos/.get.parameters[].description
Select video archives where the SQL condition `name ILIKE name_contains` is true

# paths./videos/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `name`

# paths./videos/.post.description
Use this method to add a new video archive. You have to either provide a video URL or use the `/video/{id}/upload/` method later.

# paths./videos/{id}/.get.description
Use this method to retrieve a video archive by its ID.

# paths./videos/{id}/.get.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/.put.description
Use this method to update a video archive properties.

# paths./videos/{id}/.put.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/.patch.description
Use this method to update a video archive properties.

# paths./videos/{id}/.patch.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/.delete.description
Use this method to delete a video archive.

# paths./videos/{id}/.delete.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/file/.delete.description
Use this method to delete a video archive source file (no detected objects will be deleted).

# paths./videos/{id}/file/.delete.summary
Delete video archive source file (no objects will be deleted)

# paths./videos/{id}/file/.delete.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/process/.post.description
Old artifacts will be deleted by watcher automatically

# paths./videos/{id}/process/.post.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/screenshot/.get.description
Use this method to retrieve a screenshot of a video archive stream (can be cached).

# paths./videos/{id}/screenshot/.get.summary
Retrieve a screenshot of the video stream (can be cached)

# paths./videos/{id}/screenshot/.get.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/screenshot/.get.parameters[].description
Screenshot quality (the value can be ignored if the stream is not processed by the findface-video-worker)

# paths./videos/{id}/screenshot/.get.parameters[].description
Either request screenshot with ROT or without

# paths./videos/{id}/screenshot/.post.description
Use this method to retrieve a screenshot of a video archive stream (cache invalidated).

# paths./videos/{id}/screenshot/.post.summary
Retrieve a screenshot of the video stream (invalidates cache)

# paths./videos/{id}/screenshot/.post.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/screenshot/.post.parameters[].description
Screenshot quality (the value can be ignored if the stream is not processed by the findface-video-worker)

# paths./videos/{id}/screenshot/.post.parameters[].description
Either request screenshot with ROT or without

# paths./videos/{id}/stop/.post.description
Use this method to stop video archive processing.

# paths./videos/{id}/stop/.post.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/{id}/upload/source_file/.put.description
This method uploads a video file passed in the request body. The method can't be tried out from this documentation viewer.

# paths./videos/{id}/upload/source_file/.put.parameters[].description
A unique integer value identifying this Video archive.

# paths./videos/count/.get.parameters[].description
Select videos included in these camera groups

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./videos/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./videos/count/.get.parameters[].description
Select video archives where the SQL condition `name ILIKE name_contains` is true

# paths./vms/archive/.get.description
Use this method to retrieve video archive stream link

# paths./vms/archive/.get.parameters[].description
Video speed(1.0 - normal speed and it is the only speed supported now)

# paths./vms/cleanup/.post.description
Use this method to delete all chunks from interval

# paths./vms/cleanup/.post.parameters[].description
Delete chunks from this date (UTC) or all chunks before `time_to` if not passed

# paths./vms/download/.get.description
Use this method to download all chunks from interval

# paths./vms/timeline/.get.description
Use this method to retrieve timeline info

# paths./vms/timeline/.get.parameters[].description
Max gap threshold between intervals (format: 3s, 1m, 3h, 1h3m10s).

# paths./watch-lists/.get.parameters[].description
Select only watch lists with enabled daily search (`true`) or disabled (`false`)

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./watch-lists/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# paths./watch-lists/.get.parameters[].description
Which field to use when ordering the results. Available fields: `id`, `created_date`, `modified_date`

# paths./watch-lists/.post.description
Use this method to add a new watch list.

# paths./watch-lists/{id}/.get.description
Use this method to retrieve a watch list by its ID.

# paths./watch-lists/{id}/.get.parameters[].description
A unique integer value identifying this Watch list.

# paths./watch-lists/{id}/.patch.description
Use this method to update a watch list properties.

# paths./watch-lists/{id}/.patch.parameters[].description
A unique integer value identifying this Watch list.

# paths./watch-lists/{id}/.delete.parameters[].description
A unique integer value identifying this Watch list.

# paths./watch-lists/{id}/purge/.post.description
Use this method to delete all cards from a watch list.

# paths./watch-lists/{id}/purge/.post.parameters[].description
A unique integer value identifying this Watch list.

# paths./watch-lists/count/.get.parameters[].description
Select only watch lists with enabled daily search (`true`) or disabled (`false`)

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` **greater** than this value

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` **greater than or equal** to this value

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` in last N days

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` **less** than this value

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` **less than or equal** to this value

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (including Sunday and Saturday)

# paths./watch-lists/count/.get.parameters[].description
Select objects with `created_date` in last Nth week (only working days, i.e. excluding Sunday and Saturday)

# components.schemas.Area.properties.trigger_count_gt.description
`gt` people on a frame are required for trigger activation

# components.schemas.Area.properties.trigger_count_lt.description
`lt` people on a frame are required for trigger activation

# components.schemas.Area.properties.trigger_time.description
Minimum time in seconds conditions should be met to activate triggers

# components.schemas.Area.properties.trigger_calendar.description
Area activation calendar during which an area trigger can activate. Area trigger might remain active beyond calendar intervals if the trigger activation condition is still satisfied

# components.schemas.AreaRequest.properties.trigger_count_gt.description
`gt` people on a frame are required for trigger activation

# components.schemas.AreaRequest.properties.trigger_count_lt.description
`lt` people on a frame are required for trigger activation

# components.schemas.AreaRequest.properties.trigger_time.description
Minimum time in seconds conditions should be met to activate triggers

# components.schemas.AreaRequest.properties.trigger_calendar.description
Area activation calendar during which an area trigger can activate. Area trigger might remain active beyond calendar intervals if the trigger activation condition is still satisfied

# components.schemas.AreaTriggerActivation.properties.active.description
`true` if the area trigger is active at the moment. It remains active while conditions are met

# components.schemas.AreaTriggerActivation.properties.duration.description
Time in seconds the trigger has been active

# components.schemas.AreaTriggerActivation.properties.max_body_count.description
Max people count on the frame during trigger work

# components.schemas.AreaTriggerRecord.properties.area_trigger_activation.description
Area trigger activation for which record is created

# components.schemas.AreaTriggerRecord.properties.body_bboxes.description
Array of the bbox coordinates of the counted bodies

# components.schemas.AreaTriggerRecord.properties.error.description
Area service encountered an error while processing an area

# components.schemas.AuditLog.properties.object_type.description
Type of object with which the action was performed

# components.schemas.AuditLog.properties.object_id.description
The identifier of the object with which the actions were performed

# components.schemas.BodyClusterEvent.properties.track_start_date.description
Creation date of the first related track

# components.schemas.BodyClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.BodyObjectRequest.properties.create_from.description
This field can contain one of the following references:
- `detection:<detection id>`: use a `Detection` object (obtained with the `POST /detect`)
  to select a object on `source_photo`.
  (`source_photo` must contain the same image that was used for `POST /detect`)
- `{face, body, or car}event:<event id>`: create new `Object` from an `Event`
  (`source_photo` must be empty)
- `{face, body, or car}object:<object id>`: use another `Object` as a template for this object
  (`source_photo` must be empty)

# components.schemas.BodyObjectRequest.properties.detect_id.description
*This parameter is left only for compatibility reasons. Do not use it.*

# components.schemas.BodyObjectRequest.properties.mf_selector.description
This parameter defines the FF.Multi default behaviour when there are multiple objects are present in
`source_photo`, and `create_from` is not set.

- `reject` - Reject `source_photo` with multiple objects
- `biggest` - Select the biggest object in `source_photo`

# components.schemas.BodyObjectRequest.properties.source_photo.description
Source photo (**required** when `create_from` points to a `Detection` or empty)

# components.schemas.BodyObjectUpdate.properties.source_photo_name.description
Filename supplied for `source_photo` on object creation

# components.schemas.Camera.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.Camera.properties.angle_of_view.description
Angle of view of camera in degrees, used for maps

# components.schemas.Camera.properties.pitch.description
Camera pitch, angle to horizon in degrees, used for maps

# components.schemas.CameraGroup.description
`CameraGroup` is a collection of `Camera`s, set up in same location or used for similar purposes

# components.schemas.CameraGroup.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.CameraGroup.properties.deduplicate.description
True if events from this camera group are to be deduplicated

# components.schemas.CameraGroup.properties.deduplicateDelay.description
Event deduplication timeout, default value is 15

# components.schemas.CameraGroup.properties.labels.description
Labels used to allocate a certain ``findface-video-worker`` instance to process video streams from this camera group

# components.schemas.CameraGroupRequest.description
`CameraGroup` is a collection of `Camera`s, set up in same location or used for similar purposes

# components.schemas.CameraGroupRequest.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.CameraGroupRequest.properties.deduplicate.description
True if events from this camera group are to be deduplicated

# components.schemas.CameraGroupRequest.properties.deduplicateDelay.description
Event deduplication timeout, default value is 15

# components.schemas.CameraGroupRequest.properties.labels.description
Labels used to allocate a certain ``findface-video-worker`` instance to process video streams from this camera group

# components.schemas.CameraRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CameraRequest.properties.angle_of_view.description
Angle of view of camera in degrees, used for maps

# components.schemas.CameraRequest.properties.pitch.description
Camera pitch, angle to horizon in degrees, used for maps

# components.schemas.CameraStreamSettings.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.CameraStreamSettingsRequest.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.CarCard.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CarCardAttachment.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CarCardAttachmentRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CarCardRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CarClusterEvent.properties.track_start_date.description
Creation date of the first related track

# components.schemas.CarClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.CarEpisode.properties.created_date.description
Episode creation date based on the creation date of the event

# components.schemas.CarObjectRequest.properties.create_from.description
This field can contain one of the following references:
- `detection:<detection id>`: use a `Detection` object (obtained with the `POST /detect`)
  to select a object on `source_photo`.
  (`source_photo` must contain the same image that was used for `POST /detect`)
- `{face, body, or car}event:<event id>`: create new `Object` from an `Event`
  (`source_photo` must be empty)
- `{face, body, or car}object:<object id>`: use another `Object` as a template for this object
  (`source_photo` must be empty)

# components.schemas.CarObjectRequest.properties.detect_id.description
*This parameter is left only for compatibility reasons. Do not use it.*

# components.schemas.CarObjectRequest.properties.mf_selector.description
This parameter defines the FF.Multi default behaviour when there are multiple objects are present in
`source_photo`, and `create_from` is not set.

- `reject` - Reject `source_photo` with multiple objects
- `biggest` - Select the biggest object in `source_photo`

# components.schemas.CarObjectRequest.properties.source_photo.description
Source photo (**required** when `create_from` points to a `Detection` or empty)

# components.schemas.CarObjectUpdate.properties.source_photo_name.description
Filename supplied for `source_photo` on object creation

# components.schemas.Counter.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.Counter.properties.cameras.description
Count entities from these cameras (provide either `cameras` or `camera_groups` argument)

# components.schemas.Counter.properties.multi_camera.description
Counter is related to multiple cameras or a single camera

# components.schemas.CounterRecord.properties.faces_bbox.description
Array of the bbox coordinates of the counted faces

# components.schemas.CounterRecord.properties.silhouettes_bbox.description
Array of the bbox coordinates of the counted silhouettes

# components.schemas.CounterRecord.properties.error.description
Counter service encountered an error while processing camera

# components.schemas.CounterRecord.properties.cars_bbox.description
Array of the bbox coordinates of the counted cars

# components.schemas.CounterRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.CounterRequest.properties.cameras.description
Count entities from these cameras (provide either `cameras` or `camera_groups` argument)

# components.schemas.CreateBodyEventsRequestRequest.properties.mf_selector.description
This parameter defines Findface Multi behaviour when multiple objects
 are present on `fullframe` image.

- `all` - Select all objects on `fullframe`
- `biggest` - Select the biggest object on `fullframe`

# components.schemas.CreateBodyEventsRequestRequest.properties.roi.description
ROI points coordinates for detection: left, top, right, bottom

# components.schemas.CreateBodyEventsRequestRequest.properties.temperature.description
Temperature (only for external detectors)

# components.schemas.CreateCarEventsRequestRequest.properties.mf_selector.description
This parameter defines Findface Multi behaviour when multiple objects
 are present on `fullframe` image.

- `all` - Select all objects on `fullframe`
- `biggest` - Select the biggest object on `fullframe`

# components.schemas.CreateCarEventsRequestRequest.properties.roi.description
ROI points coordinates for detection: left, top, right, bottom

# components.schemas.CreateFaceEventsRequestRequest.properties.mf_selector.description
This parameter defines Findface Multi behaviour when multiple objects
 are present on `fullframe` image.

- `all` - Select all objects on `fullframe`
- `biggest` - Select the biggest object on `fullframe`

# components.schemas.CreateFaceEventsRequestRequest.properties.roi.description
ROI points coordinates for detection: left, top, right, bottom

# components.schemas.CreateFaceEventsRequestRequest.properties.temperature.description
Temperature (only for external detectors)

# components.schemas.DetectCarFeatureRequest.description
Requested car features. Might be an empty dict

# components.schemas.DetectResponse.properties.objects.description
Returned objects with requested attributes

# components.schemas.DetectorParameters.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.DetectorParametersRequest.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.Detectors.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.DetectorsRequest.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.DeviceBlacklistRecord.properties.reason.description
Blacklisting reason, up to 512 characters

# components.schemas.DeviceBlacklistRecordRequest.properties.reason.description
Blacklisting reason, up to 512 characters

# components.schemas.FaceClusterEvent.properties.track_start_date.description
Creation date of the first related track

# components.schemas.FaceClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.FaceObjectRequest.properties.create_from.description
This field can contain one of the following references:
- `detection:<detection id>`: use a `Detection` object (obtained with the `POST /detect`)
  to select a object on `source_photo`.
  (`source_photo` must contain the same image that was used for `POST /detect`)
- `{face, body, or car}event:<event id>`: create new `Object` from an `Event`
  (`source_photo` must be empty)
- `{face, body, or car}object:<object id>`: use another `Object` as a template for this object
  (`source_photo` must be empty)

# components.schemas.FaceObjectRequest.properties.detect_id.description
*This parameter is left only for compatibility reasons. Do not use it.*

# components.schemas.FaceObjectRequest.properties.mf_selector.description
This parameter defines the FF.Multi default behaviour when there are multiple objects are present in
`source_photo`, and `create_from` is not set.

- `reject` - Reject `source_photo` with multiple objects
- `biggest` - Select the biggest object in `source_photo`

# components.schemas.FaceObjectRequest.properties.source_photo.description
Source photo (**required** when `create_from` points to a `Detection` or empty)

# components.schemas.FaceObjectUpdate.properties.source_photo_name.description
Filename supplied for `source_photo` on object creation

# components.schemas.GeocodingResponse.properties.value.description
The value returned by the geocoding service

# components.schemas.GeocodingResponse.properties.lat.description
Latitude returned by the geocoding service

# components.schemas.GeocodingResponse.properties.lon.description
Longitude returned by the geocoding service

# components.schemas.HumanCard.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.HumanCardAttachment.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.HumanCardAttachmentRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.HumanCardRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.HumanEpisode.properties.created_date.description
Episode creation date based on the creation date of the event

# components.schemas.Line.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.Line.properties.attributes.description
line attributes each up to 256 characters

# components.schemas.Line.properties.ab_attributes.description
AB direction attributes each up to 256 characters

# components.schemas.Line.properties.ba_attributes.description
BA direction attributes each up to 256 characters

# components.schemas.LineAttributes.properties.attributes.description
line attributes each up to 256 characters

# components.schemas.LineAttributes.properties.ab_attributes.description
AB direction attributes each up to 256 characters

# components.schemas.LineAttributes.properties.ba_attributes.description
BA direction attributes each up to 256 characters

# components.schemas.LineRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.LineRequest.properties.attributes.description
line attributes each up to 256 characters

# components.schemas.LineRequest.properties.ab_attributes.description
AB direction attributes each up to 256 characters

# components.schemas.LineRequest.properties.ba_attributes.description
BA direction attributes each up to 256 characters

# components.schemas.LoginRequestRequest.properties.video_auth_token.description
Inactive token from face authorization. Required when `face_and_password` is set

# components.schemas.MetaDictionary.description
`MetaDictionary` is a collection of values from which you can select a meta value

# components.schemas.MetaDictionary.properties.name.description
Short dictionary name, up to 256 characters

# components.schemas.MetaDictionary.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.MetaDictionaryRequest.description
`MetaDictionary` is a collection of values from which you can select a meta value

# components.schemas.MetaDictionaryRequest.properties.name.description
Short dictionary name, up to 256 characters

# components.schemas.MetaDictionaryRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedAreaRequest.properties.trigger_count_gt.description
`gt` people on a frame are required for trigger activation

# components.schemas.PatchedAreaRequest.properties.trigger_count_lt.description
`lt` people on a frame are required for trigger activation

# components.schemas.PatchedAreaRequest.properties.trigger_time.description
Minimum time in seconds conditions should be met to activate triggers

# components.schemas.PatchedAreaRequest.properties.trigger_calendar.description
Area activation calendar during which an area trigger can activate. Area trigger might remain active beyond calendar intervals if the trigger activation condition is still satisfied

# components.schemas.PatchedBodyClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.PatchedCameraGroupRequest.description
`CameraGroup` is a collection of `Camera`s, set up in same location or used for similar purposes

# components.schemas.PatchedCameraGroupRequest.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.PatchedCameraGroupRequest.properties.deduplicate.description
True if events from this camera group are to be deduplicated

# components.schemas.PatchedCameraGroupRequest.properties.deduplicateDelay.description
Event deduplication timeout, default value is 15

# components.schemas.PatchedCameraGroupRequest.properties.labels.description
Labels used to allocate a certain ``findface-video-worker`` instance to process video streams from this camera group

# components.schemas.PatchedCameraRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedCameraRequest.properties.angle_of_view.description
Angle of view of camera in degrees, used for maps

# components.schemas.PatchedCameraRequest.properties.pitch.description
Camera pitch, angle to horizon in degrees, used for maps

# components.schemas.PatchedCarCardAttachmentRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedCarCardRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedCarClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.PatchedCounterRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedCounterRequest.properties.cameras.description
Count entities from these cameras (provide either `cameras` or `camera_groups` argument)

# components.schemas.PatchedFaceClusterEventRequest.properties.track_start_date.description
Creation date of the first related track

# components.schemas.PatchedHumanCardAttachmentRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedHumanCardRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedLineRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedLineRequest.properties.attributes.description
line attributes each up to 256 characters

# components.schemas.PatchedLineRequest.properties.ab_attributes.description
AB direction attributes each up to 256 characters

# components.schemas.PatchedLineRequest.properties.ba_attributes.description
BA direction attributes each up to 256 characters

# components.schemas.PatchedOnvifSetVideoSourceRequest.properties.bounds.description
Bounds structure containing either the whole VideoSource pixel area or a sub-portion of it

# components.schemas.PatchedSettingsRequest.properties.minimum_face_quality.description
Minimum face quality for inclusion in a card

# components.schemas.PatchedSettingsRequest.properties.minimum_car_quality.description
Minimum car quality for inclusion in a card

# components.schemas.PatchedSettingsRequest.properties.minimum_body_quality.description
Minimum body quality for inclusion in a card

# components.schemas.PatchedSettingsRequest.properties.ignore_unmatched.description
If enabled, unmatched events won't be saved to the database

# components.schemas.PatchedSettingsRequest.properties.license_accepted.description
By setting this option to "true", you indicate that you have read and accepted the FindFace Security         license agreement.

# components.schemas.PatchedSettingsRequest.properties.face_events_max_matched_age.description
Matched face events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_events_max_unmatched_age.description
Unmatched face events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_events_max_fullframe_matched_age.description
Fullframes from matched face events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_events_max_fullframe_unmatched_age.description
Fullframes from unmatched face events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_cluster_events_max_age.description
Face cluster events older than `face_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_cluster_events_keep_best_max_age.description
Face cluster events except of best cluster event older than `face_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_events_max_matched_age.description
Matched car events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_events_max_unmatched_age.description
Unmatched car events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_events_max_fullframe_matched_age.description
Fullframes from matched car events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_events_max_fullframe_unmatched_age.description
Fullframes from unmatched car events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_cluster_events_max_age.description
Car cluster events older than `car_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.car_cluster_events_keep_best_max_age.description
Car cluster events except of best cluster event older than `car_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_events_max_matched_age.description
Matched body events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_events_max_unmatched_age.description
Unmatched body events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_events_max_fullframe_matched_age.description
Fullframes from matched body events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_events_max_fullframe_unmatched_age.description
Fullframes from unmatched body events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_cluster_events_max_age.description
Body cluster events older than `body_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.body_cluster_events_keep_best_max_age.description
Body cluster events except of best cluster event older than `body_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.PatchedSettingsRequest.properties.face_events_features.description
Features to extract when creating face events

# components.schemas.PatchedSettingsRequest.properties.body_events_features.description
Features to extract when creating body events

# components.schemas.PatchedSettingsRequest.properties.car_events_features.description
Features to extract when creating car events

# components.schemas.PatchedSettingsRequest.properties.liveness_threshold.description
Liveness classifier threshold (if liveness is enabled)

# components.schemas.PatchedUpdateDeviceBlacklistRecordRequest.properties.reason.description
Blacklisting reason, up to 512 characters

# components.schemas.PatchedUpdateMetaDictionaryRequest.description
`MetaDictionary` is a collection of values from which you can select a meta value

# components.schemas.PatchedUpdateMetaDictionaryRequest.properties.name.description
Short dictionary name, up to 256 characters

# components.schemas.PatchedUpdateMetaDictionaryRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedUserRequest.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.PatchedWatchListRequest.properties.name.description
Short watch list name, up to 256 characters

# components.schemas.PatchedWatchListRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.PatchedWatchListRequest.properties.notify.description
`true` if the notifications on the watch list enabled

# components.schemas.PatchedWatchListRequest.properties.acknowledge.description
Require manual acknowledgment of the events that match with the watch list

# components.schemas.PatchedWatchListRequest.properties.camera_groups.description
List of the camera groups used to monitor the watch list 

# components.schemas.PatchedWatchListRequest.properties.send_events_to_external_vms.description
`true` if events matched with this watch list should be sent to an external VMS

# components.schemas.PatchedWatchListRequest.properties.collect_location.description
`true` to enable daily search for cards from this watch list

# components.schemas.PatchedWebhookRequest.description
`WebHook` is an HTTP URL that is used to notify external services on newly created events

# components.schemas.PatchedWebhookRequest.properties.active.description
Inactive webhooks will not send any requests

# components.schemas.PatchedWebhookRequest.properties.send_attempts.description
Maximum number of attempts to send a webhook

# components.schemas.Report.properties.filters.description
Filters available for the passed entity `type` can be used. Filters list can be found in the list endpoint of entity type

# components.schemas.ReportRequest.properties.filters.description
Filters available for the passed entity `type` can be used. Filters list can be found in the list endpoint of entity type

# components.schemas.Schedule.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.ScheduleRequest.description
Serializer mixin that raises ValidationError if excess fields are presented.
Can be used in nested serializers

# components.schemas.SearchRequest.properties.limit.description
Maximum number of objects in Ovision response

# components.schemas.SearchRequest.properties.with_mask.description
Use an algorithm for recognition in a mask

# components.schemas.Settings.properties.minimum_face_quality.description
Minimum face quality for inclusion in a card

# components.schemas.Settings.properties.minimum_car_quality.description
Minimum car quality for inclusion in a card

# components.schemas.Settings.properties.minimum_body_quality.description
Minimum body quality for inclusion in a card

# components.schemas.Settings.properties.ignore_unmatched.description
If enabled, unmatched events won't be saved to the database

# components.schemas.Settings.properties.license_accepted.description
By setting this option to "true", you indicate that you have read and accepted the FindFace Security         license agreement.

# components.schemas.Settings.properties.face_events_max_matched_age.description
Matched face events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_events_max_unmatched_age.description
Unmatched face events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_events_max_fullframe_matched_age.description
Fullframes from matched face events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_events_max_fullframe_unmatched_age.description
Fullframes from unmatched face events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_cluster_events_max_age.description
Face cluster events older than `face_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_cluster_events_keep_best_max_age.description
Face cluster events except of best cluster event older than `face_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_events_max_matched_age.description
Matched car events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_events_max_unmatched_age.description
Unmatched car events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_events_max_fullframe_matched_age.description
Fullframes from matched car events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_events_max_fullframe_unmatched_age.description
Fullframes from unmatched car events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_cluster_events_max_age.description
Car cluster events older than `car_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.car_cluster_events_keep_best_max_age.description
Car cluster events except of best cluster event older than `car_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_events_max_matched_age.description
Matched body events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_events_max_unmatched_age.description
Unmatched body events older than `events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_events_max_fullframe_matched_age.description
Fullframes from matched body events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_events_max_fullframe_unmatched_age.description
Fullframes from unmatched body events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_cluster_events_max_age.description
Body cluster events older than `body_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.body_cluster_events_keep_best_max_age.description
Body cluster events except of best cluster event older than `body_cluster_events_max_age` will be removed every night by the cleanup script

# components.schemas.Settings.properties.face_events_features.description
Features to extract when creating face events

# components.schemas.Settings.properties.body_events_features.description
Features to extract when creating body events

# components.schemas.Settings.properties.car_events_features.description
Features to extract when creating car events

# components.schemas.Settings.properties.liveness_threshold.description
Liveness classifier threshold (if liveness is enabled)

# components.schemas.Status.properties.enabled.description
`true` for the camera enabled through findface-video-manager

# components.schemas.StatusRequest.properties.enabled.description
`true` for the camera enabled through findface-video-manager

# components.schemas.Track.properties.track_points.description
Track points by line intersection points

# components.schemas.UpdateDeviceBlacklistRecord.properties.reason.description
Blacklisting reason, up to 512 characters

# components.schemas.User.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.UserFaceRequest.properties.create_from.description
This field can contain one of the following references:
- `detection:<detection id>`: use a `Detection` object (obtained with the `POST /detect`)
  to select a object on `source_photo`.
  (`source_photo` must contain the same image that was used for `POST /detect`)
- `{face, body, or car}event:<event id>`: create new `Object` from an `Event`
  (`source_photo` must be empty)
- `{face, body, or car}object:<object id>`: use another `Object` as a template for this object
  (`source_photo` must be empty)

# components.schemas.UserFaceRequest.properties.detect_id.description
*This parameter is left only for compatibility reasons. Do not use it.*

# components.schemas.UserFaceRequest.properties.mf_selector.description
This parameter defines the FF.Multi default behaviour when there are multiple objects are present in
`source_photo`, and `create_from` is not set.

- `reject` - Reject `source_photo` with multiple objects
- `biggest` - Select the biggest object in `source_photo`

# components.schemas.UserFaceRequest.properties.source_photo.description
Source photo (**required** when `create_from` points to a `Detection` or empty)

# components.schemas.UserFaceUpdate.properties.source_photo_name.description
Filename supplied for `source_photo` on object creation

# components.schemas.UserRequest.properties.comment.description
Extended description of the user, up to 2048 chars

# components.schemas.VideoArchive.properties.finished.description
`true` if the video processing is finished

# components.schemas.VideoArchive.properties.queued.description
`true` if the video is in the processing queue

# components.schemas.VideoArchive.properties.face_cluster_count.description
Count of face clusters created from this video

# components.schemas.VideoArchive.properties.body_cluster_count.description
Count of body clusters created from this video

# components.schemas.VideoArchive.properties.car_cluster_count.description
Count of car clusters created from this video

# components.schemas.VmsCleanupSettings.properties.keep_event_before_after.description
interval in `seconds` to be added to track

# components.schemas.VmsCleanupSettings.properties.cleanup_threshold.description
cleanup threshold  in `seconds` between tracks that will not be deleted

# components.schemas.VmsCleanupSettings.properties.between_tracks_cleanup_start_age.description
delete video between track older than specified age

# components.schemas.VmsCleanupSettingsRequest.properties.keep_event_before_after.description
interval in `seconds` to be added to track

# components.schemas.VmsCleanupSettingsRequest.properties.cleanup_threshold.description
cleanup threshold  in `seconds` between tracks that will not be deleted

# components.schemas.VmsCleanupSettingsRequest.properties.between_tracks_cleanup_start_age.description
delete video between track older than specified age

# components.schemas.WatchList.properties.name.description
Short watch list name, up to 256 characters

# components.schemas.WatchList.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.WatchList.properties.notify.description
`true` if the notifications on the watch list enabled

# components.schemas.WatchList.properties.acknowledge.description
Require manual acknowledgment of the events that match with the watch list

# components.schemas.WatchList.properties.camera_groups.description
List of the camera groups used to monitor the watch list 

# components.schemas.WatchList.properties.send_events_to_external_vms.description
`true` if events matched with this watch list should be sent to an external VMS

# components.schemas.WatchList.properties.collect_location.description
`true` to enable daily search for cards from this watch list

# components.schemas.WatchListPermissions.properties.name.description
Short watch list name, up to 256 characters

# components.schemas.WatchListRequest.properties.name.description
Short watch list name, up to 256 characters

# components.schemas.WatchListRequest.properties.comment.description
Extended description, up to 2048 characters

# components.schemas.WatchListRequest.properties.notify.description
`true` if the notifications on the watch list enabled

# components.schemas.WatchListRequest.properties.acknowledge.description
Require manual acknowledgment of the events that match with the watch list

# components.schemas.WatchListRequest.properties.camera_groups.description
List of the camera groups used to monitor the watch list 

# components.schemas.WatchListRequest.properties.send_events_to_external_vms.description
`true` if events matched with this watch list should be sent to an external VMS

# components.schemas.WatchListRequest.properties.collect_location.description
`true` to enable daily search for cards from this watch list

# components.schemas.Webhook.description
`WebHook` is an HTTP URL that is used to notify external services on newly created events

# components.schemas.Webhook.properties.active.description
Inactive webhooks will not send any requests

# components.schemas.Webhook.properties.send_attempts.description
Maximum number of attempts to send a webhook

# components.schemas.WebhookRequest.description
`WebHook` is an HTTP URL that is used to notify external services on newly created events

# components.schemas.WebhookRequest.properties.active.description
Inactive webhooks will not send any requests

# components.schemas.WebhookRequest.properties.send_attempts.description
Maximum number of attempts to send a webhook

# components.securitySchemes.Bearer.description
Use `/auth/login` to obtain a valid `token` and paste it in this form: ```Token <token>```