GET/api/partner/v1/gps/alerts

GPS alerts

Telematics events we detected for your cars.

Events raised from the vehicle track: ignition on and off, a trip ending, and a suspected tow — the car moved with the engine off. This is a journal, so it reaches much further back than the raw positions behind it.

Authorization

X-Api-Key header

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

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.

carIdstringquery

Restrict to one of your cars (our id or your external car id). Omit for the whole fleet over the period — neither form requires a booking or a driver.

pageintegerquery

1-based page number.

Default: 1

pageSizeintegerquery

Rows per page. Capped at 1000.

Default: 100

Response

200 · application/json

successbooleanrequired

dataobject

The shape of data on every list endpoint. items is added by each list's own schema.

pageintegerrequired

1-based page number you asked for.

pageSizeintegerrequired

totalintegerrequired

Rows in the whole filtered set

hasMorebooleanrequired

Another page is waiting — request page+1.

itemsGpsAlert[]

errorstringnullable

Status codes

200One page of events.

400Validation error.

401Missing, unknown or revoked API key.