Skip to main content
POST
Driver Behaviour Metrics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Body

application/json;charset=UTF-8

Request parameters for driver behaviour metrics including date range, metrics keys, and driver identifier

startDate
string<date-time>
required

Start date and time for the behaviour metrics period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC.

endDate
string<date-time>
required

End date and time for the behaviour metrics period. Format: yyyy-MM-dd'T'HH:mm:ss in UTC.

keys
string[]

Array of keys for the KPI to return details for. Possible values:

  • DrivingPercentage (Cleaner KPI)
  • SpeedCompliance (Safe Speed KPI)
  • HarshEventsPercentage (Smoother KPI)

timeZone
string

Timezone identifier for the request (e.g., 'Europe/London', 'UTC')

driverId
string

Identifier of a driver

Response

Successful operation

key
string

Metric key identifier (e.g., 'DrivingPercentage', 'SpeedCompliance', 'HarshEventsPercentage')

value
number<double>

Current metric value for the specified period

previousValue
number<double>

Previous metric value for comparison with the current period

startDate
string<date-time>

Start date and time for the daily metric period

endDate
string<date-time>

End date and time for the daily metric period