Synthesis

The group synthesis service provides a group’s scores and driving statistics. The data are obtained by averaging scores and aggregating trip data over the group's entire activity, the current month, and the current week.

The group synthesis is updated each time a new trip is analyzed.

If you have your admin API key, you can try the API via this link

Synthesis of group's scores

GET https://service.drivequant.com/v3/drivekit/admin/group/synthesis

Get a synthesis of DriveQuant scores and statistics for a specified group.

Query Parameters

Name	Type	Description
label	string	Group name

Headers

Name	Type	Description
DriveKit-Admin-API-Key	string	Admin API Key

200

{
  "groupInfos": {
    "id": "GROUP_ID",
    "label": "GROUP_NAME",
    "numberDrivers": 10,
    "owner": "OWNER_USERNAME",
    "managers": [
      "MANAGER1_USERNAME",
      "MANAGER2_USERNAME"
    ],
    "visitors": [
      "VISITOR_USERNAME"
    ],
    "creationDate": "2020-07-01T12:27:41.707+0000",
    "active": true
  },
  "scoresTimeRange": {
    "efficiency": {
      "overall": 7.9,
      "currentWeek": 7.8,
      "currentMonth": 8.36
    },
    "safety": {
      "overall": 8.98,
      "currentWeek": 10,
      "currentMonth": 9.11
    },
    "phoneDistraction": {
      "overall": 8.67,
      "currentWeek": 5.93,
      "currentMonth": 7.42
    },
    "speeding": {
      "overall": 6.7,
      "currentWeek": 6.98,
      "currentMonth": 5.61
    },
    "distance": {
      "overall": 34183.9,
      "currentWeek": 3.8,
      "currentMonth": 2427.3
    },
    "acceleration": {
      "overall": 816,
      "currentWeek": 0,
      "currentMonth": 39
    },
    "braking": {
      "overall": 2883,
      "currentWeek": 0,
      "currentMonth": 213
    },
    "adherence": {
      "overall": 1459,
      "currentWeek": 1,
      "currentMonth": 79
    },
    "fuelVolume": {
      "overall": 2177.474,
      "currentWeek": 0.302,
      "currentMonth": 158.443
    },
    "co2Mass": {
      "overall": 5326.308,
      "currentWeek": 1,
      "currentMonth": 79
    },
    "duration": {
      "overall": 35914,
      "currentWeek": 14,
      "currentMonth": 2560
    },
    "numberTrip": {
      "overall": 1493,
      "currentWeek": 2,
      "currentMonth": 86
    }
  },
  "scoresRoadContext": [
    {
      "roadContext": "TRAFFIC_JAM",
      "distance": 1485.1,
      "duration": 148,
      "efficiencyScore": 11,
      "safetyScore": 11
    },
    {
      "roadContext": "HEAVY_URBAN_TRAFFIC",
      "distance": 867,
      "duration": 57,
      "efficiencyScore": 7.93,
      "safetyScore": 9.89
    },
    {
      "roadContext": "CITY",
      "distance": 9936.4,
      "duration": 377.8,
      "efficiencyScore": 7.17,
      "safetyScore": 8.75
    },
    {
      "roadContext": "SUBURBAN",
      "distance": 8434.4,
      "duration": 131.6,
      "efficiencyScore": 8.15,
      "safetyScore": 9.12
    },
    {
      "roadContext": "EXPRESSWAYS",
      "distance": 24990.5,
      "duration": 229.7,
      "efficiencyScore": 9.2,
      "safetyScore": 9.41
    }
  ]
}

401

404

If you do not enter a label in the query, the service will return information from a group composed of all the drivers belonging to your organisation.

Response

The table below summarizes the list of synthesis data.

Field	Type	Description
groupInfos	GroupInfos	Group information
scoresTimeRange	ScoresTimeRange	Driving statistics and average scores per period
scoresRoadContext	ScoresRoadContext	Driving statistics and average scores per road context

GroupInfos

Field	Type	Description
id	string	Unique identifier of the group
label	string	Group name
numberDrivers	int	Number of driver registered in this group
owner	string	Unique identifier of the group owner
managers	array[string]	Vector of unique identifiers of group managers
visitors	array[string]	Vector of unique identifiers of group visitors
creationDate	string	Group creation date
isActive	boolean	If the group is active or not

ScoresTimeRange

For each theme (efficiency, safety, phoneDistraction, speeding, distance, acceleration, braking, adherence, fuelVolume, co2Mass):

Field	Type	Description
overall	double	Average score based on all trips
currentWeek	double	Average score based on trips performed during the current week
currentMonth	double	Average score based on trips performed during the current month

ScoresRoadContext

Field	Type	Description
roadContext	string	Road context (see below)
distance	double	Total driving distance (in km)
duration	double	Total driving duration (in min)
efficiencyScore	double	Average ecodriving score
safetyScore	double	Average safety score

Road context

Driving contexts are calculated from the GPS velocity. They are not based on map data.

Value	Description
TRAFFIC_JAM	Speed below 10 km/h and distance between two stops greater than 100m
HEAVY_URBAN_TRAFFIC	Speed below 30 km/h and distance between two stops greater than 100m
CITY	30 km/h < Speed < 65 km/h
SUBURBAN	65 km/h < Speed < 96 km/h
EXPRESSWAYS	Speed > 96 km/h