events

List face events

Use this method to list face events.

get/events/faces/

Query parameters

acknowledgedboolean

true - select only acknowledged events (do not require acknowledgement), false - select only unacknowledged events

age_gtenumber

Select events where features.age is greater than or equal to this value

age_ltenumber

Select events where features.age is less than or equal to this value

backward_line_crossingboolean

true - select only events with backward intersected line. false - select only events intersected line in one direction.

beardstring[]

Select events where features.beard.name takes one of these values

beard_score_gtenumber

Select events where features.beard.confidence is greater than or equal to this value

beard_score_ltenumber

Select events where features.beard.confidence is less than or equal to this value

bs_type'overall' | 'realtime'

Select objects where bs_type takes one of these values

camera_groupsinteger[]

Get events from these camera groups

camerasinteger[]

Get events from these cameras

case_ininteger[]

Select events related to these cases

created_date_gtestring date-time

Select objects with created_date greater than or equal to this value

created_date_last_n_daysnumber

Select objects with created in last N days

created_date_ltestring date-time

Select objects with created_date less than or equal to this value

created_date_nth_full_weeknumber

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

created_date_nth_work_weeknumber

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

emotionsstring[]

Select events where features.emotions.name takes one of these values

emotions_score_gtenumber

Select events where features.emotions.confidence is greater than or equal to this value

emotions_score_ltenumber

Select events where features.emotions.confidence is less than or equal to this value

episodeinteger

Select events that matched this episode

external_detectorboolean

Select events that created by external detectors

eyes_attrsstring[]

Select events where features.eyes_attrs.name takes one of these values

eyes_attrs_score_gtenumber

Select events where features.eyes_attrs.confidence is greater than or equal to this value

eyes_attrs_score_ltenumber

Select events where features.eyes_attrs.confidence is less than or equal to this value

genderstring[]

Select events where features.gender.name takes one of these values

gender_score_gtenumber

Select events where features.gender.confidence is greater than or equal to this value

gender_score_ltenumber

Select events where features.gender.confidence is less than or equal to this value

glassesstring[]

Select events where features.glasses.name takes one of these values

glasses_score_gtenumber

Select events where features.glasses.confidence is greater than or equal to this value

glasses_score_ltenumber

Select events where features.glasses.confidence is less than or equal to this value

has_caseboolean

true - select only events relates to case. false - select only events without case.

headpose_pitch_angle_gtenumber

Select events where features.headpose.pitch is greater than or equal to this value

headpose_pitch_angle_ltenumber

Select events where features.headpose.pitch is less than or equal to this value

headpose_yaw_angle_gtenumber

Select events where features.headpose.yaw is greater than or equal to this value

headpose_yaw_angle_ltenumber

Select events where features.headpose.yaw is less than or equal to this value

idnumber

Exact filter by ID

id_gtenumber

Select objects with id greater than or equal to this value

id_instring[]

Select objects with provided ids

id_ltenumber

Select objects with id less than or equal to this value

latitude_gtenumber

Select events where latitude is greater than or equal to this value

latitude_ltenumber

Select events where latitude is less than or equal to this value

limitinteger

Number of results to return per page.

lineinteger[]

Select events that intersects with this lines

line_crossing_directionstring[]

Select events that intersect line in these directions

livenessstring[]

Select events where features.liveness.name takes one of these values

liveness_score_gtenumber

Select events where features.liveness.confidence is greater than or equal to this value

liveness_score_ltenumber

Select events where features.liveness.confidence is less than or equal to this value

longitude_gtenumber

Select events where longitude is greater than or equal to this value

longitude_ltenumber

Select events where longitude is less than or equal to this value

lookstring[]

Select events where features.look.name takes one of these values

look_score_gtenumber

Select events where features.look.confidence is greater than or equal to this value

look_score_ltenumber

Select events where features.look.confidence is less than or equal to this value

looks_likestring

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

matched_cardinteger

Filter is deprecated

matched_card_ininteger[]

Select events that matched these cards

matched_listsinteger[]

Select events that match a card included in these watch lists

medmaskstring[]

Select events where features.medmask.name takes one of these values

medmask_score_gtenumber

Select events where features.medmask.confidence is greater than or equal to this value

medmask_score_ltenumber

Select events where features.medmask.confidence is less than or equal to this value

no_matchboolean

true - select only events without matches. false - select events only with matches.

orderingstring

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

pagestring

Pagination cursor value.

temperature_gtenumber

Select events where temperature is greater than or equal to this value

temperature_ltenumber

Select events where temperature is less than or equal to this value

thresholdnumber

Similarity threshold for looks_like

video_archiveinteger[]

Get events from these video archives

Response

next_pagestring uri nullable
countinteger

Changes

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