episodes

List human episodes

Use this method to list human episodes.

get/episodes/humans/

Query parameters

acknowledgedboolean

Select only acknowledged episodes (true) or unacknowledged (false) episodes

acknowledged_byinteger

Select episodes acknowledged by user

acknowledged_reactionstring

Select only episodes with this acknowledgment reaction

age_groupstring[]

Select episodes where feature age_group takes one of these values

age_gtestring

Select episodes where featureage is greater than or equal to this value

age_ltestring

Select episodes where feature age is lower than or equal to this value

bag_backstring[]

Select episodes where feature bag_back takes one of these values

bag_groundstring[]

Select episodes where feature bag_ground takes one of these values

bag_handstring[]

Select episodes where feature bag_hand takes one of these values

beardstring[]

Select episodes where feature beard takes one of these values

body_genderstring[]

Select episodes where feature gender takes one of these values(body feature)

bottom_colorstring[]

Select episodes where feature bottom_color takes one of these values

camera_groupsinteger[]

Select episodes associated with the specified camera groups

camerasinteger[]

Select episodes associated with the specified cameras

case_ininteger[]

Select episodes related to these cases

closed_date_gtestring date-time

Select episodes with closed_date greater than or equal to this value

created_date_gtstring date-time

Select objects with created_date greater than this value

created_date_gtestring date-time

Select objects with created_date greater than or equal to this value

created_date_last_n_daysnumber

Select objects with created_date in last N days

created_date_ltstring date-time

Select objects with created_date less than this value

created_date_ltestring date-time

Select objects with created_date less than or equal to this value

created_date_nth_full_weeknumber

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

created_date_nth_work_weeknumber

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

detailed_upper_clothesstring[]

Select episodes where feature detailed_upper_clothes takes one of these values

emotionsstring[]

Select episodes where feature emotions takes one of these values

events_count_gteinteger

Select episodes with number of events is greater or equal than or equal to this value

eyes_attrsstring[]

Select episodes where feature eyes_attrs takes one of these values

fallstring[]

Select episodes where feature fall takes one of these values

genderstring[]

Select episodes where feature gender takes one of these values

glassesstring[]

Select episodes where feature glasses takes one of these values

handface_phone_callstring[]

Select episodes where feature handface_phone_call takes one of these values

handface_phone_usestring[]

Select episodes where feature handface_phone_use takes one of these values

handface_smokingstring[]

Select episodes where feature handface_smoking takes one of these values

handface_taking_picturesstring[]

Select episodes where feature handface_taking_pictures takes one of these values

has_bodyboolean

Select only episodes with body (true) or without body (false)

has_caseboolean

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

has_faceboolean

Select only episodes with face (true) or without face (false)

headwearstring[]

Select episodes where feature headwear takes one of these values

helmet_typestring[]

Select episodes where feature helmet_type takes one of these values

helmet_type_gtestring

Select episodes where feature helmet_type_score is greater than or equal to this value

helmet_type_score_ltestring

Select episodes where feature helmet_type_score is lower than or equal to this value

id_ininteger[]

Select episodes with provided ids

last_body_eventstring

Select only the episode with the last body event of the given id

last_body_event_date_gtestring date-time

Select episodes with last_body_event_date greater than or equal to this value

last_face_eventstring

Select only the episode with the last face event of the given id

last_face_event_date_gtestring date-time

Select episodes with last_face_event_date greater than or equal to this value

latitude_gtenumber float

Select episodes where best event latitude greater than or equal to this value

latitude_ltenumber float

Select episodes where best event latitude less than or equal to this value

limitstring

Number of results to return per page.

livenessstring[]

Select episodes where feature liveness takes one of these values

longitude_gtenumber float

Select episodes where best event longitude greater than or equal to this value

longitude_ltenumber float

Select episodes where best event longitude less than or equal to this value

lookstring[]

Select episodes where feature look takes one of these values

lower_clothesstring[]

Select episodes where feature lower_clothes takes one of these values

matched_cardinteger

Filter is deprecated

matched_card_ininteger[]

Select episodes that match these cards

matched_listsinteger[]

Select episodes associated with the specified watch lists

medmaskstring[]

Select episodes where feature medmask takes one of these values

no_body_matchboolean

Select only episodes without matched body (true) or with matched body (false)

no_face_matchboolean

Select only episodes without matched face (true) or with matched face (false)

openboolean

Select only open episodes (true) or closed (false) episodes

orderingstring

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

pagestring

Pagination cursor value.

top_colorstring[]

Select episodes where feature top_color takes one of these values

upper_clothesstring[]

Select episodes where feature upper_clothes takes one of these values

vest_typestring[]

Select episodes where feature vest_type takes one of these values

vest_type_score_gtestring

Select episodes where feature vest_type_score is greater than or equal to this value

vest_type_score_ltestring

Select episodes where feature vest_type_score is lower than or equal to this value

video_archiveinteger[]

Select episodes associated with the specified video archives

Response

next_pagestring nullable
prev_pagestring nullable

Changes

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