Search vehicles

Search vehicle detections of the application's organization.

Only timeRange is required; every other filter is optional. Filters are combined with AND
semantics, values inside an array filter are OR-ed.

Results are sorted by startTime descending (newest first) and paginated with page/size
(zero-based page, size 1..100, default 25).
The response envelope always includes the total number of detections matching the filters, so
total can exceed items.length.

cameraIds and locationIds intersect: a detection must match all provided scope filters.
An empty intersection returns an empty page with total: 0.

Each returned detection carries its trackerId, objectId (PERSON / VEHICLE), the
detection startTime and endTime in milliseconds since epoch, the camera, edge and location
names, the IANA timezone of the camera location, and two image URLs: thumbnailUrl
(GET /v3/search/trackers/{trackerId}/thumbnail, the detection frame) and identityUrl
(GET /v3/search/trackers/{trackerId}/identity, the cropped object). Fetch either with the
same access token — Authorization: Bearer <token> header. Either URL can be
null when the image is unavailable.

Filters:

filtermeaning
timeRangeRequired. { start, end } in milliseconds since epoch.
cameraIdsOnly detections from these cameras.
locationIdsOnly detections from cameras at these locations.
colorsVehicle colors.
makesVehicle makes.
modelsVehicle models. Exact match, case-sensitive (e.g. Corolla, X5).
typesVehicle types.
licensePlateLicense plate substring (LPR match). Normalized to uppercase, minimum 2 characters.
plateRegionLicense plate region prefix (e.g. state or country code).

Attribute values:

filtervalues
colorsBLACK, BLUE, BROWN, GREEN, GREY, ORANGE, PINK, PURPLE, RED, YELLOW, WHITE
typesSEDAN, SUV, VAN, PICKUP_TRUCK, MOTORCYCLE, BUS, BIG_TRUCK, BICYCLE, FORKLIFT, BOAT, SCOOTER
makesAcura, Audi, BMW, Buick, Cadillac, Chevrolet, Chrysler, Dodge, Ferrari, Fiat, Ford, Genesis, GMC, Honda, Hyundai, Infiniti, Jaguar, Jeep, Kia, Land Rover, Lexus, Lincoln, Mazda, Mercedes-Benz, Mini, Mitsubishi, Nissan, Porsche, RAM, Subaru, Tesla, Toyota, Volkswagen, Volvo

Detected vehicle attributes are returned on each item when the analytics report them, with or
without a license plate: color, make, type (the same values as the types filter),
model, licensePlate and plateRegion. Each is returned only when detected with high
confidence, the confidence the filters match on. When the analytics report several colors, makes or
types for a vehicle, color, make and type are the ones the request filters on in
colors, makes and types, otherwise the analytics' first choice. color is the
lowercase form of the colors values (white for WHITE). make can be a make that is
not among the makes values (for example Daihatsu), which cannot be filtered on. type is
omitted for a vehicle the analytics did not classify; a types search can also return such
vehicles.

Request examples:

{ "timeRange": { "start": 1752451200000, "end": 1752537600000 } }
{
  "timeRange": { "start": 1752451200000, "end": 1752537600000 },
  "colors": ["WHITE"],
  "makes": ["Toyota"],
  "types": ["SUV"],
  "page": 0,
  "size": 25
}
{
  "timeRange": { "start": 1752451200000, "end": 1752537600000 },
  "licensePlate": "8ABC123",
  "plateRegion": "CA"
}
{
  "timeRange": { "start": 1752451200000, "end": 1752537600000 },
  "makes": ["BMW"],
  "models": ["X5"]
}

Required scope: read:search

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The vehicle search filters and pagination.

timeRange
object
required

Time range to search in (milliseconds since epoch)

cameraIds
array of strings

Only detections from these cameras

cameraIds
locationIds
array of strings

Only detections from cameras at these locations

locationIds
colors
array of objects

Vehicle colors

colors
makes
array of objects

Vehicle makes

makes
models
array of strings

Vehicle models (exact match, case-sensitive)

models
types
array of objects

Vehicle types

types
string
length ≥ 2

License plate substring (LPR match, case-insensitive)

string

License plate region prefix (e.g. state or country code)

number
Defaults to 0

Page number for pagination (zero-based)

number
≤ 100
Defaults to 25

Number of items per page

Responses

400

Invalid request: missing timeRange, unknown color/make/type value, licensePlate shorter than 2 characters, page below 0, or size outside 1..100.

500

Internal server error.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*