events

List car events

Use this method to list car events.

get/events/cars/

Query parameters

acknowledgedboolean

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

backward_line_crossingboolean

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

bodystring[]

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

body_score_gtenumber

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

body_score_ltenumber

Select events where features.body.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

category_score_gtenumber

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

category_score_ltenumber

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

category_typestring[]

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

colorstring[]

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

color_score_gtenumber

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

color_score_ltenumber

Select events where features.color.confidence is less than or equal to 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 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)

episodeinteger

Select events that matched this episode

external_detectorboolean

Select events that created by external detectors

has_caseboolean

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

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

license_plate_countrystring[]

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

license_plate_country_score_gtenumber

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

license_plate_country_score_ltenumber

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

license_plate_number_colorstring[]

Select events where features.license_plate_number_color takes one of these values

license_plate_number_color_score_gtenumber

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

license_plate_number_color_score_ltenumber

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

license_plate_number_containsstring[]

Select events where features.model.license_plate_number contains provided string(case insensitive)

license_plate_number_score_gtenumber

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

license_plate_number_score_ltenumber

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

license_plate_regionstring[]

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

license_plate_region_score_gtenumber

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

license_plate_region_score_ltenumber

Select events where features.license_plate_region.confidence 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

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

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

makestring[]

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

make_score_gtenumber

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

make_score_ltenumber

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

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

modelstring[]

Select events where features.model.name contains provided string(case insensitive)

model_score_gtenumber

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

model_score_ltenumber

Select events where features.model.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

orientationstring[]

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

orientation_score_gtenumber

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

orientation_score_ltenumber

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

pagestring

Pagination cursor value.

special_vehicle_typestring[]

Select events where features.special_vehicle_type.name contains provided string(case insensitive)

special_vehicle_type_score_gtenumber

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

special_vehicle_type_score_ltenumber

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

thresholdnumber

Similarity threshold for looks_like

video_archiveinteger[]

Get events from these video archives

weight_typestring[]

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

weight_type_score_gtenumber

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

weight_type_score_ltenumber

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

Response

next_pagestring uri nullable
countinteger

Changes

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