- Legion API
- Tracks
- Search tracks
Search tracks
POST
/v3/tracks/search
const url = 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/tracks/search?include_classification_vector=false&limit=10&offset=0&with_location_latest=false';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"filters":{"affiliation":["FRIEND","NEUTRAL"],"category":["DEVICE","SENSOR"],"created_after":"2024-01-01T00:00:00Z","created_before":"2024-12-31T23:59:59Z","entity_ids":["c3d4e5f6-a1b2-7890-1234-567890abcdef","e5f6a1b2-c3d4-7890-1234-567890abcdef"],"expires_after":"2025-01-01T00:00:00Z","expires_before":"2026-12-31T23:59:59Z","is_active":true,"name":"Camera","parent_ids":["a1b2c3d4-e5f6-7890-1234-567890abcdef"],"status":["example"],"top_classifications":["HUMAN","VEHICLE"],"types":["Camera","Environmental"],"updated_after":"2024-02-01T00:00:00Z","updated_before":"2024-03-31T23:59:59Z"},"sort":[{"field":"created_at","order":"desc"}],"with_location_latest":false}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.hopper.west.prod.govcloud.legion.picogrid.com/v3/tracks/search?include_classification_vector=false&limit=10&offset=0&with_location_latest=false' \ --header 'Content-Type: application/json' \ --data '{ "filters": { "affiliation": [ "FRIEND", "NEUTRAL" ], "category": [ "DEVICE", "SENSOR" ], "created_after": "2024-01-01T00:00:00Z", "created_before": "2024-12-31T23:59:59Z", "entity_ids": [ "c3d4e5f6-a1b2-7890-1234-567890abcdef", "e5f6a1b2-c3d4-7890-1234-567890abcdef" ], "expires_after": "2025-01-01T00:00:00Z", "expires_before": "2026-12-31T23:59:59Z", "is_active": true, "name": "Camera", "parent_ids": [ "a1b2c3d4-e5f6-7890-1234-567890abcdef" ], "status": [ "example" ], "top_classifications": [ "HUMAN", "VEHICLE" ], "types": [ "Camera", "Environmental" ], "updated_after": "2024-02-01T00:00:00Z", "updated_before": "2024-03-31T23:59:59Z" }, "sort": [ { "field": "created_at", "order": "desc" } ], "with_location_latest": false }'Search tracks with complex filtering and pagination
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”include_classification_vector
boolean
limit
integer
Example
10offset
integer
Example
0with_location_latest
boolean
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
filters
object
affiliation
Array<string>
Example
[ "FRIEND", "NEUTRAL"]category
Array<string>
Example
[ "DEVICE", "SENSOR"]created_after
string
Example
2024-01-01T00:00:00Zcreated_before
string
Example
2024-12-31T23:59:59Zentity_ids
Array<string>
Example
[ "c3d4e5f6-a1b2-7890-1234-567890abcdef", "e5f6a1b2-c3d4-7890-1234-567890abcdef"]expires_after
string
Example
2025-01-01T00:00:00Zexpires_before
string
Example
2026-12-31T23:59:59Zis_active
boolean
Example
truename
string
Example
Cameraparent_ids
Array<string>
Example
[ "a1b2c3d4-e5f6-7890-1234-567890abcdef"]status
Array<string>
top_classifications
Array<string>
Example
[ "HUMAN", "VEHICLE"]types
Array<string>
Example
[ "Camera", "Environmental"]updated_after
string
Example
2024-02-01T00:00:00Zupdated_before
string
Example
2024-03-31T23:59:59Zsort
Array<object>
object
field
required
string
Example
created_atorder
required
string
Example
descExample
{ "field": "created_at", "order": "desc"}with_location_latest
boolean
Example
falseResponses
Section titled “Responses”Successful response
Media typeapplication/json
object
paging
required
object
next
required
integer | null
previous
required
integer | null
results
required
Array<object>
object
affiliation
required
string
category
required
string
classification
object
key
additional properties
any
created_at
required
string
deleted_at
string
expires_at
string
id
required
string format: uuid
is_active
boolean
is_expired
required
boolean
location_latest
object
acceleration
Array<number>
angular_velocity
Array<number>
bearing
number
covariance
Array<Array<number>>
created_at
required
string
crs
string
entity_id
required
string format: uuid
id
required
string format: uuid
orientation
Array<number>
position
required
object
coordinates
required
Array<number>
type
required
string
radius
number
recorded_at
string
source
required
string
speed
number
velocity
Array<number>
metadata
object
key
additional properties
any
name
required
string
organization_id
required
string format: uuid
parent_id
required
string | null format: uuid
status
required
string
top_classification
string
top_classification_probability
number
type
required
string
updated_at
required
string
total_count
required
integer
Example
{ "paging": { "next": 2, "previous": null }, "results": [ { "affiliation": "FRIEND", "category": "DEVICE", "created_at": "2023-12-15T14:30:00Z", "id": "123e4567-e89b-12d3-a456-426614174000", "metadata": { "manufacturer": "General Atomics", "model": "MQ-9" }, "name": "MQ-9 Reaper", "organization_id": "550e8400-e29b-41d4-a716-446655440000", "parent_id": "456e8400-e29b-41d4-a716-446655440000", "status": "ACTIVE", "type": "DRONE", "updated_at": "2023-12-15T14:30:00Z" } ], "total_count": 25}Bad Request
Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{ "code": 400, "details": [ { "Field": "organization_id", "Issue": "must be a valid UUID format" } ], "message": "Request cannot be processed due to invalid input", "status": "error", "timestamp": "2026-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Unauthorized
Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{ "code": 401, "details": [ { "Field": "authorization_header", "Issue": "Bearer token is expired or malformed" } ], "message": "Authentication credentials are missing or invalid", "status": "error", "timestamp": "2026-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Forbidden
Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{ "code": 403, "details": [ { "Field": "required_scope", "Issue": "requires 'orion:settings:write' scope, but token only has 'orion:settings:read'" } ], "message": "Access denied: insufficient permissions for this resource", "status": "error", "timestamp": "2026-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Not Found
Media typeapplication/json
object
category
required
string
code
required
number
details
Array<object>
object
field
required
string
issue
required
string
message
required
string
status
required
string
timestamp
required
string
trace_id
required
string
Example
{ "code": 404, "details": [ { "Field": "organization_id", "Issue": "organization with ID 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' not found" } ], "message": "The requested resource could not be found", "status": "error", "timestamp": "2026-01-15T14:32:45Z", "trace_id": "req_2J9K8L7M6N5P4Q3R"}Internal Server Error
Media typeapplication/json
object
category
required
The category of the error
string
code
required
The HTTP status code
number
details
Additional details about the error
Array<object>
object
field
The field that caused the error
string
issue
The specific issue with the field
string
message
required
A human-readable error message
string
status
required
The status of the response, always ‘error’ for error responses
string
timestamp
required
The timestamp when the error occurred
string format: date-time
trace_id
required
A unique identifier for tracing the error
string format: uuid
Example
{ "category": "server_error", "code": 500, "details": [ { "field": "field_name", "issue": "Field validation issue" } ], "message": "Internal Server Error", "status": "error", "timestamp": "2024-03-15T10:30:00Z", "trace_id": "b7c5e4d3-a2b1-4f0e-8d9c-1a2b3c4d5e6f"}Version 3.14.0 · commit 0771262
