GET/api/partner/v1/cars/{carId}/gps/mileage

Car mileage

How far one car drove over a period.

Distance summed from the car's own fixes, with no-fix pings and physically impossible jumps excluded so a single bad reading cannot inflate a bill. coveredFromUtc/coveredToUtc say which part of the period actually had data: positionCount: 0 means it is no longer measurable, not that the car stood still.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Path parameters

carIdstringpathrequired

Query parameters

fromstringquery

Start of the window (UTC, inclusive). Defaults to 30 days before to.

tostringquery

End of the window (UTC, exclusive). Defaults to now.

Response

200 · application/json

successbooleanrequired

dataobject

Distance driven over a window, summed from the vehicle's own fixes.

carIdstring

externalCarIdstringnullable

bookingIdstringnullable

Set on the booking-scoped read.

externalBookingIdstringnullable

fromUtcstring <date-time>

toUtcstring <date-time>

distanceMilesnumber

distanceKmnumber

positionCountinteger

Fixes the figure was summed from. 0 or 1 means no distance could be measured.

coveredFromUtcstring <date-time>nullable

First fix actually found in the window — null when the period holds none.

coveredToUtcstring <date-time>nullable

truncatedboolean

The window held more fixes than one request reads; the distance is then a lower bound.

errorstringnullable

Status codes

200The distance driven in the window.

400Validation error.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.