Skip to main content
POST
Driver Behaviour Group Metrics

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 group behaviour metrics including date range, metrics keys, and group 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')

hierarchyNodeId
string

Unique identifier of an existing group to retrieve behaviour metrics for

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