Search vehicle detections of the organization associated with the API key.
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 /v1/search/trackers/{trackerId}/thumbnail, the detection frame) and croppedImageUrl
(GET /v1/search/trackers/{trackerId}/cropped-image, the cropped object). Fetch either with the
same API key — Authorization: Bearer <token> header (preferred) or ?token=<token> query
parameter for <img> embedding (note: query tokens can appear in access logs). Either URL can be
null when the image is unavailable.
Filters:
| filter | meaning |
|---|---|
timeRange | Required. { start, end } in milliseconds since epoch. |
cameraIds | Only detections from these cameras. |
locationIds | Only detections from cameras at these locations. |
colors | Vehicle colors. |
makes | Vehicle makes. |
models | Vehicle models. Exact match, case-sensitive (e.g. Corolla, X5). |
types | Vehicle types. |
licensePlate | License plate substring (LPR match). Normalized to uppercase, minimum 2 characters. |
plateRegion | License plate region prefix (e.g. state or country code). |
Attribute values:
| filter | values |
|---|---|
colors | BLACK, BLUE, BROWN, GREEN, GREY, ORANGE, PINK, PURPLE, RED, YELLOW, WHITE |
types | SEDAN, SUV, VAN, PICKUP_TRUCK, MOTORCYCLE, BUS, BIG_TRUCK, BICYCLE, FORKLIFT, BOAT |
makes | Acura, 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 (color, make, licensePlate, plateRegion) are returned on
each item when available.
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"]
}| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
400Invalid request: missing timeRange, unknown color/make/type value, licensePlate shorter than 2 characters, page below 0, or size outside 1..100.
401Missing or invalid API key.
403Organization not allowed by this token.
500Internal server error.
