Skip to main content
GET
/
customer
/
{customerId}
/
driverbehaviourmetrics
/
vehicle
/
summary
Driver Behaviour Vehicle Summary
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/driverbehaviourmetrics/vehicle/summary \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "totalCount": 123,
  "items": [
    {
      "fuel": 123,
      "stops": 123,
      "harshBraking": 123,
      "harshAcceleration": 123,
      "idleTime": 123,
      "ptoIdle": 123,
      "distanceKms": 123,
      "speedingKms": 123,
      "countOfSpeedingEpisodes": 123,
      "driveTime": 123,
      "harshEvents": 123,
      "drivePlusIdleTime": 123,
      "smootherHarshPer100kms": 123,
      "smootherPercentage": 123,
      "safeSpeedPercentage": 123,
      "cleanerPercentage": 123,
      "groupId": "<string>",
      "groupName": "<string>",
      "totalCO2Kg": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "vehicleRegistration": "<string>",
      "vehicleName": "<string>",
      "vehicleId": "<string>",
      "energyType": "<string>",
      "fuelType": [
        "<string>"
      ],
      "fuelUsedPetrolEquivalentLitres": 123,
      "gasUsedKg": 123,
      "electricUsedKWh": 123,
      "fuelUsedLitres": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

customerId
string
required

Customer identifier

Query Parameters

driverId
string

Identifier (alphanumeric) of a driver.
Must be provided if a value for groupId and vehicleId is not provided.

groupId
string

Identifier (alphanumeric) of a group.
Must be provided if a value for vehicleId and driverId is not provided.

vehicleId
string

Identifier (alphanumeric) of a vehicle.
Must be provided if a value for groupId and driverId is not provided.

startDate
string<date-time>
required

The start date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss.

endDate
string<date-time>
required

The end date and time for the period, in UTC, in the format of YYYY-MM-DDThh:mm:ss.

pageIndex
integer
default:0

Specifies the pagination page index.
Pages are zero indexed, i.e.
the first page has an index value of zero.
If not specified, then will default to a pageIndex of 0.

pageSize
integer
default:50

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
If not specified, then will default to a pageSize of 50.
Maximum pageSize is 100.

Required range: x <= 100

Response

Successful operation

Paginated response containing driver behaviour summary results

totalPages
integer

Total number of pages based on the pageSize.

totalCount
integer

Total number of behaviour metrics that matched the search parameters.

items
object[]

Array of behaviour metrics.