Search fleet performance
Returns a paginated, sortable list of every vehicle in the project joined with its period performance metrics (routes, stops breakdown, distance, time, price,…
Returns a paginated, sortable list of every vehicle in the project joined with its period performance metrics (routes, stops breakdown, distance, time, price, tracing, planned baselines). Vehicles with no activity in the period are included with null metrics and sort last. Use sort_by (a column id, e.g. perf_stops_per_hour, completion_rate) + sort_direction to rank the fleet; predicates delimits the period (created_at). With include_diagnosis, sort_by=diagnosis ranks the fleet by verdict severity, so desc puts the vehicles that require attention first; vehicles with no verdict, or too small a sample to judge, sort last in both directions.
Authorization
api_key Pass your API key as the private_key query string parameter. Generate and rotate keys in Developer Settings of your Routal workspace.
Keys stay server-side. Never ship them to a browser or mobile app.
In: query
Query Parameters
Project ID
^[0-9a-f]{24}Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v2/vehicles/performance?project_id=string" \ -H "Content-Type: application/json" \ -d '{}'{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}Create multiple vehicles (v3)
Bulk-creates vehicles in a project, each with its full configuration: capacity, skills (provides), working hours, breaks, start and end locations, driver, tran…
Which of these vehicles has a live driver-app session
Returns { sessions: { <vehicleid: boolean } } for the vehicle ids given — meant for the rows currently on screen.