Trips
2 operations at https://api.zaitrack.app. Request and response bodies are JSON with camelCase keys; ids are UUIDs; times are RFC 3339 in UTC.
Every operation needs an API key, a personal access token or an OAuth access token unless it says otherwise. An Idempotency-Key is replayed for 24 hours; see Idempotency. Errors are application/problem+json; see Errors.
List trips
GET /v1/trips
- Scope:
trips:readortrips:* - Rate class:
read(100 per second and 360,000 per hour) - Idempotency-Key: not used
- Audited: no
- Step-up MFA: no
| Query parameter | Type | Notes |
|---|---|---|
status | string | |
pageSize | string | |
cursor | string | |
vehicleId | — | |
driverId | — | |
deviceId | — | |
trailerId | — | |
from | — | |
to | — |
Request
No body.
Response
200: fields the handler writes, taken from its source.
| Field | Type | Notes |
|---|---|---|
items | array of object | |
items[].id | string | |
items[].deviceId | string | |
items[].vehicleId | string | may be null |
items[].driverId | string | may be null |
items[].trailerId | string | may be null |
items[].status | string | |
items[].startedAt | string | |
items[].endedAt | string | may be null |
items[].start | object | may be null |
items[].start.lat | number | |
items[].start.lon | number | |
items[].end | object | may be null |
items[].end.lat | number | |
items[].end.lon | number | |
items[].distanceKm | number | |
items[].durationSec | integer | |
items[].maxSpeedKph | number | |
items[].avgSpeedKph | number | |
items[].idleSec | integer | |
items[].overspeedEvents | integer | |
items[].harshBrakeEvents | integer | |
items[].harshAccelEvents | integer | |
items[].harshCornerEvents | integer | |
items[].endReason | string | omitted when empty |
items[].odometerStartKm | number | omitted when empty |
items[].odometerEndKm | number | omitted when empty |
nextCursor | — |
Example
curl "https://api.zaitrack.app/v1/trips" \
-H "Authorization: Bearer zk_test_…"
Get a trip
GET /v1/trips/{id}
- Scope:
trips:readortrips:* - Rate class:
read(100 per second and 360,000 per hour) - Idempotency-Key: not used
- Audited: no
- Step-up MFA: no
Path parameters: id.
Request
No body.
Response
200: fields the handler writes, taken from its source.
| Field | Type | Notes |
|---|---|---|
id | string | |
deviceId | string | |
vehicleId | string | may be null |
driverId | string | may be null |
trailerId | string | may be null |
status | string | |
startedAt | string | |
endedAt | string | may be null |
start | object | may be null |
start.lat | number | |
start.lon | number | |
end | object | may be null |
end.lat | number | |
end.lon | number | |
distanceKm | number | |
durationSec | integer | |
maxSpeedKph | number | |
avgSpeedKph | number | |
idleSec | integer | |
overspeedEvents | integer | |
harshBrakeEvents | integer | |
harshAccelEvents | integer | |
harshCornerEvents | integer | |
endReason | string | omitted when empty |
odometerStartKm | number | omitted when empty |
odometerEndKm | number | omitted when empty |
Example
curl "https://api.zaitrack.app/v1/trips/$ID" \
-H "Authorization: Bearer zk_test_…"