Retrieve a vehicle's metric time series
Time series of a vehicle's metrics against its fleet, bucketed by day or week, for the Overview sparklines and trend chart.
Time series of a vehicle's metrics against its fleet, bucketed by day or week, for the Overview sparklines and trend chart. Buckets come from the execution date of the plans the routes belong to; metrics use the same definitions as the vitals endpoint. One point per bucket with fleet activity, with the vehicle's values null where it did not work. Fleet values are only returned for rates and ratios — a fleet volume total is not comparable to a single vehicle. predicates delimits the period (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/timeseries?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"
}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.
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…