Retrieve vehicle vital signs
Returns the headline vital metrics (on-time, completion, cancellation, stops/hour, total cost, cost/stop, distance) for a vehicle: its value this period, its p…
Returns the headline vital metrics (on-time, completion, cancellation, stops/hour, total cost, cost/stop, distance) for a vehicle: its value this period, its previous-period value (for the delta), and the fleet distribution (median/min/max/rank) that powers the "vs fleet" benchmark. It also returns breakdowns: what those numbers are made of (stops by status, delay figures, the terms of the cost, and the reasons behind the cancellations), and diagnosis: the verdict for this vehicle, from the same rule and the same numbers the fleet list uses, so the detail and the list cannot disagree. predicates and previous_predicates delimit the current and comparison periods (created_at).
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
Path Parameters
Vehicle ID
^[0-9a-f]{24}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/string/vitals?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"
}