Skip to main content
GET
Safety score (V2)

Overview

Returns trip-level safety scores for the specified vehicle. Supports explicit date ranges or preset time windows via intervalType.
This endpoint is not yet deployed in the staging environment (api-stage.telemax.com.au). All requests to staging return PATH_NOT_FOUND. Test against production only.
The V1 version of this endpoint is Safety score.
Rate limit: 10 req/s · 30/min · 6,000/hr · 144,000/day

Endpoint

GET /v2/api/safety-score/{id}

Path parameters

integer
required
Vehicle ID.

Query parameters

string (datetime)
Range start. Optional when intervalType is supplied.
string (datetime)
Range end. Optional when intervalType is supplied.
integer
Preset window, used only when start and finish are omitted:
  • 1 — instant range (uses DateTime.UtcNow as start)
  • 2 — relative to end of today in the user’s timezone
  • 3 — three-day window
  • 4 — week window
⚠️ The window arithmetic uses a double-negative (-TimeSpan.FromDays(-N)) which adds days to finish for types 2–4. Validate results in staging before using preset windows in production.

Response

200 OK — array of trip safety score objects.

Error responses

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping: API key tokens are scoped to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

id
integer
required

Query Parameters

start
string<date-time>
finish
string<date-time>
intervalType
integer

Preset window: 1=instant, 2=today, 3=3-day, 4=week.

Response

Successful response