Skip to main content
POST
Driver Behaviour Group Ranking

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId
string
required

Body

application/json;charset=UTF-8

Request parameters for driver behaviour person metrics ranking 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)

includeTopHierarchy
boolean

Flag to include top hierarchy in ranking calculation

driverId
string

Identifier of a driver

Response

Successful operation

key
string

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

rankInGroup
object

Behaviour metric ranking data containing rank position and total active driver count

rankInCustomer
object

Behaviour metric ranking data containing rank position and total active driver count