References (Android)

DKDriverTimeline

DKDriverTimeline is an object that contains timeline data for the given period.

data class DKDriverTimeline(
    val period: DKPeriod,
    val allContext: List<DKAllContextItem>,
    val roadContexts: Map<RoadContext, List<DKRoadContextItem>>
) : Serializable

Attribute	Type	Description
period	DKPeriod	The kind of aggregation period for this timeline
allContext	List<DKAllContextItem>	The list of all global context sorted by date
roadContexts	Map<RoadContext, List<DKRoadContextItem>>	The map of all road context and their associated list of context data sorted by date

DKPeriod

DKPeriod indicates the aggregation size of each timeline object. It is an enum with the following values:

WEEK	Timeline data is aggregated week by week
MONTH	Timeline data is aggregated month by month
YEAR	Timeline data is aggregated year by year

enum class DKPeriod: Serializable {
    WEEK, MONTH, YEAR
}

DKAllContextItem

DKAllContextItem is an object that contains data for global context for the given period.

data class DKAllContextItem(
        override val date: Date,
        val numberTripScored: Int,
        val numberTripTotal: Int,
        val distance: Double,
        val duration: Int,
        val safety: DKSafety?,
        val ecoDriving: DKEcoDriving?,
        val phoneDistraction: DKDistraction?,
        val speeding: DKSpeeding?,
        val drivingConditions: DKDrivingConditions?
) : Serializable, DatedContextItem

Attribute	Type	Description
date	Date	Start date of the given period
numberTripTotal	Int	Total number of trips made during the given period
numberTripScored	Int	Number of trips made that were long enough to have a score during the given period
distance	Double	Total distance travelled during the given period (in kilometers)
duration	Int	Total trip duration during the given period (in minutes)
safety	DKSafety?	Safety's score and sub scores for the given period (present only if safety score is configured and the period has some scored trips)
ecoDriving	DKEcoDriving?	Eco-driving's score and sub scores for the given period (present only if eco-driving score is configured and the period has some scored trips)
phoneDistraction	DKDistraction?	Distraction's score and sub scores for the given period (present only if distraction score is configured)
speeding	DKSpeeding?	Speeding's score and sub scores for the given period (present only if speeding score is configured)
drivingConditions	DKDrivingConditions?	Advanced informations for a given period (total trip and distance for a specific DKDrivingCategory and by DKWeather, distance travelled by day/night and by weekdays/weekend)

DKSafety

DKSafety is an object that contains data for safety's score and sub scores.

data class DKSafety(
        val score: Double,
        val acceleration: Int,
        val braking: Int,
        val adherence: Int
) : Serializable

Attribute	Type	Description
score	Double	Global safety score for the given period (ranging from 3 to 10)
acceleration	Int	Number of harsh accelerations during the given period
braking	Int	Number of hard breakings during the given period
adherence	Int	Number of adherence limits during the given period

DKEcoDriving

DKEcoDriving is an object that contains data for eco-driving's score and sub scores.

data class DKEcoDriving(
        val score: Double,
        val efficiencyBrake: Double,
        val efficiencyAcceleration: Double,
        val efficiencySpeedMaintain: Double,
        val co2Mass: Double,
        val fuelVolume: Double,
        val fuelSaving: Double
) : Serializable

Attribute	Type	Description
score	Double	Global eco-driving score for the given period (ranging from 4 to 10)
efficiencyAcceleration	Double	Sub score of acceleration efficiency for the given period (ranging from -5 to 5)
efficiencyBrake	Double	Sub score of braking efficiency for the given period (ranging from -5 to 5)
efficiencySpeedMaintain	Double	Sub score of speed maintain efficiency for the given period (ranging from 0 to 5)
fuelVolume	Double	Fuel consumption during the given period (in liters)
fuelSaving	Double	Achievable fuel savings during the given period (in liters)
co2Mass	Double	CO₂ mass consumed during the given period (in kilograms)

DKDistraction

DKDistraction is an object that contains data for distraction's score and sub scores.

data class DKDistraction(
        val score: Double,
        val unlock: Int,
        val lock: Int,
        val callAuthorized: Int,
        val callForbidden: Int,
        val callAuthorizedDuration: Int,
        val callForbiddenDuration: Int,
        val numberTripWithForbiddenCall: Int
) : Serializable

Attribute	Type	Description
score	Double	Global distraction score for the given period (ranging from 0 to 10)
unlock	Int	Number of screen unlocks during the given period
lock	Int	Number of screen locks during the given period
callForbiddenDuration	Int	Duration of forbidden calls during the given period (in seconds)
numberTripWithForbiddenCall	Int	Number of trips during which the driver made forbidden calls during the given period
callForbidden	Int	Number of forbidden calls during the given period
callAuthorizedDuration	Int	Duration of authorised calls during the given period (in seconds)
callAuthorized	Int	Number of authorised calls during the given period

DKSpeeding

DKSpeeding is an object that contains data for speeding's score and sub scores.

data class DKSpeeding(
    val score: Double,
    val speedingDuration: Int,
    val speedingDistance: Double,
) : Serializable

Attribute	Type	Description
score	Double	Global speeding score for the given period (ranging from 0 to 10)
speedingDuration	Int	Overspeeding duration during the given period (in seconds)
speedingDistance	Double	Overspeeding distance travelled during the given period (in meters)

DKDrivingConditions

DKDrivingConditions is an object that contains advanced driving information for the given period.

data class DKDrivingConditions (
    val tripCountByCategory: Map<DKDrivingCategory, Int>,
    val distanceByCategory: Map<DKDrivingCategory, Double>,
    val tripCountByWeatherType: Map<DKWeather, Int>,
    val distanceByWeatherType: Map<DKWeather, Double>,
    val dayDistance: Double,
    val nightDistance: Double,
    val weekdaysDistance: Double,
    val weekendDistance: Double
) : Serializable

Attribute	Type	Description
tripCountByCategory	Map<DKDrivingCategory, Int>	Total trips count by driving category
distanceByCategory	Map<DKDrivingCategory, Double>	Total distance in km by driving category
tripCountByWeatherType	Map<DKWeather, Int>	Total trips count by weather category
distanceByWeatherType	Map<DKWeather, Double>	Total distance in km count by weather category
dayDistance	Double	Total distance traveled by the day in km
nightDistance	Double	Total distance traveled by night in km
weekdaysDistance	Double	Total distance traveled during weekdays in km
weekendDistance	Double	Total distance traveled during weekend in km

DKDrivingCategory

enum class DKDrivingCategory(val index: Int) {
    LESS_THAN_2_KM(0),
    FROM_2_TO_10_KM(1),
    FROM_10_TO_50_KM(2),
    FROM_50_TO_100_KM(3),
    MORE_THAN_100_KM(4);
}

Attribute	Description
LESS_THAN_2_KM	Trip distance strictly below 2 km
FROM_2_TO_10_KM	Trip distance in [2, 10[ km
FROM_10_TO_50_KM	Trip distance in [10, 50[ km
FROM_50_TO_100_KM	Trip distance in [50, 100[ km
MORE_THAN_100_KM	Trip distance is equals or above 100 km

DKRoadContextItem

DKRoadContextItem is an object that contains data for the given road context and given period.

data class DKRoadContextItem(
        val type: RoadContext,
        override val date: Date,
        val numberTripTotal: Int,
        val numberTripScored: Int,
        val distance: Double,
        val duration: Int,
        val safety: DKSafety?,
        val ecoDriving: DKEcoDriving?
) : Serializable, DatedContextItem

Attribute	Type	Description
type	RoadContext	Road context for the given period
date	Date	Start date of the given period
numberTripTotal	Int	Total number of trips made during the given period and road context
numberTripScored	Int	Number of trips made that were long enough to have a score during the given period and road context
distance	Double	Total distance travelled during the given period and road context (in kilometers)
duration	Int	Total trip duration during the given period and road context (in minutes)
safety	DKSafety?	Safety's score and sub scores for the given period and road context (present only if safety score is configured and the period has some scored trips)
ecoDriving	DKEcoDriving?	Eco-driving's score and sub scores for the given period and road context (present only if eco-driving score is configured and the period has some scored trips)

RoadContext

RoadContext indicates the kind of roads where the data was gathered. It is an enum with the following values:

Value	Description
TRAFFIC_JAM	The targeted driver was in traffic jams
HEAVY_URBAN_TRAFFIC	The targeted driver was in dense city roads
CITY	The targeted driver was in light traffic city roads
SUBURBAN	The targeted driver was in suburban or countryside roads
EXPRESSWAYS	The targeted driver was in express ways

enum class RoadContext : Serializable {
    EXPRESSWAYS, HEAVY_URBAN_TRAFFIC, CITY, SUBURBAN, TRAFFIC_JAM
}

---

DKDriverProfile

DKDriverProfile is the object describing the driver profile.

Attribute	Type	Description
distance	DKDistanceProfile	Distance class
activity	DKActivityProfile	Activity class
regularity	DKRegularityProfile	Regularity class
mainRoadContext	RoadContext	Main road context
mobility	DKMobilityProfile	Mobility class
statistics	DKDriverStatistics	Statistics about the driver
weekRegularity	DKDriverRegularity	Information about driver’s week regularity
monthRegularity	DKDriverRegularity	Information about driver’s month regularity
distanceEstimation	DKDriverDistanceEstimation	Distance estimation by week, month or year
roadContextInfoByRoadContext	Map<RoadContext, DKRoadContextInfo>	Contains information about road contexts
commonTripByType	Map<DKCommonTripType, DKCommonTrip>	Provides information about common trips, by type of trip
mobilityAreaRadiusByType	Map<DKMobilityAreaType, Int>	Provides radius of mobility area by type of mobility

@Keep
data class DKDriverProfile(
    val distance: DKDistanceProfile,
    val activity: DKActivityProfile,
    val regularity: DKRegularityProfile,
    val mainRoadContext: RoadContext,
    val mobility: DKMobilityProfile,
    val statistics: DKDriverStatistics,
    val weekRegularity: DKDriverRegularity,
    val monthRegularity: DKDriverRegularity,
    val distanceEstimation: DKDriverDistanceEstimation,
    val roadContextInfoByRoadContext: Map<RoadContext, DKRoadContextInfo>,
    val commonTripByType: Map<DKCommonTripType, DKCommonTrip>,
    val mobilityAreaRadiusByType: Map<DKMobilityAreaType, Int>
)

DKDistanceProfile

DKDistanceProfile indicates the distance class of the driver.

Value	Description	Estimated yearly distance (in km)
VERY_SHORT	Very short distance driver	less than 5000
SHORT	Short distance driver	5000 to 10000
MEDIUM	Medium distance driver	10000 to 20 000
LONG	Long distance driver	20 000 to 40 000
VERY_LONG	Professional driver	more than 40 000

@Keep
enum class DKDistanceProfile {
    VERY_SHORT,
    SHORT,
    MEDIUM,
    LONG,
    VERY_LONG
}

DKActivityProfile

DKActivityProfile indicates the activity class of the driver.

Value	Description	Percentage of active weeks
LOW	Low activity driver	less than 30 %
MEDIUM	Medium activity driver	30 to 60 %
HIGH	High activity driver	more than 60 %

@Keep
enum class DKActivityProfile {
    LOW,
    MEDIUM,
    HIGH
}

DKRegularityProfile

DKRegularityProfile indicates the regularity class of the driver.

Value	Description
REGULAR	Regular driver
INTERMITTENT	Intermittent driver

@Keep
enum class DKRegularityProfile {
    REGULAR,
    INTERMITTENT
}

DKMobilityProfile

DKMobilityProfile indicates the mobility class of the driver.

Value	Description
NARROW	90% of trips are within a radius of less than 10 km
SMALL	90% of trips are within a radius of less than 20 km
MEDIUM	90% of trips are within a radius of less than 30 km
LARGE	90% of trips are within a radius of less than 50 km
WIDE	90% of trips are within a radius of less than 100 km
VAST	90% of trips are within a radius of 100 km or more

@Keep
enum class DKMobilityProfile {
    NARROW,
    SMALL,
    MEDIUM,
    LARGE,
    WIDE,
    VAST
}

DKDriverStatistics

DKDriverStatistics is an object providing statistics about the driver.

Attribute	Type	Description
tripsNumber	Int	Total number of trips
totalDistance	Int	Total distance (in km)
totalDuration	Int	Total driving duration (in min)
weekNumber	Int	Number of weeks since user registration
activeWeekNumber	Int	Number of active weeks since user registration
monthNumber	Int	Number of months since user registration
activeMonthNumber	Int	Number of active months since user registration
peakTime	DKTime	Peak time trip starts
peakDay	DKDay	Weekday with most trips completed

@Keep
data class DKDriverStatistics(
    val tripsNumber: Int,
    val totalDistance: Int,
    val totalDuration: Int,
    val weekNumber: Int,
    val activeWeekNumber: Int,
    val monthNumber: Int,
    val activeMonthNumber: Int,
    val peakTime: DKTime,
    val peakDay: DKDay
)

DKDriverRegularity

DKDriverRegularity is an object providing information about driver’s regularity.

Attribute	Type	Description
periodNumber	Int	Number of weeks or months used to calculate regularity
tripNumberMean	Int	Average number of trips per week or month
tripNumberStandardDeviation	Int	Standard deviation of the number of trips per week or month
distanceMean	Int	Average weekly or monthly distance (in km)
distanceStandardDeviation	Int	Standard deviation of the weekly or monthly distance (in km)
durationMean	Int	Average weekly or monthly driving duration (in min)
durationStandardDeviation	Int	Standard deviation of the weekly or monthly driving duration (in min)

@Keep
data class DKDriverRegularity(
    val periodNumber: Int,
    val tripNumberMean: Int,
    val tripNumberStandardDeviation: Int,
    val distanceMean: Int,
    val distanceStandardDeviation: Int,
    val durationMean: Int,
    val durationStandardDeviation: Int
)

DKDriverDistanceEstimation

DKDriverDistanceEstimation is an object providing distance estimation by week, month or year.

Attribute	Type	Description
weekDistance	Int	Estimated weekly distance (in km)
monthDistance	Int	Estimated monthly distance (in km)
yearDistance	Int	Estimated annual distance (in km)
confidence	DKDriverDistanceEstimationConfidence	Confidence level indicator, based on the available data

@Keep
data class DKDriverDistanceEstimation(
    val weekDistance: Int,
    val monthDistance: Int,
    val yearDistance: Int,
    val confidence: DKDriverDistanceEstimationConfidence
)

DKDriverDistanceEstimationConfidence

DKDriverDistanceEstimationConfidence indicates the distance estimation confidence class.

Value	Description
LOW	If less than 8 weeks since driver’s subscription
MEDIUM	If between 9 and 16 weeks since driver’s subscription
HIGH	If more than 16 weeks since driver’s subscription

@Keep
enum class DKDriverDistanceEstimationConfidence {
    LOW,
    MEDIUM,
    HIGH
}

DKRoadContextInfo

DKRoadContextInfo is an object providing information about road context for the driver.

Attribute	Type	Description
roadContext	RoadContext	Road context
distancePercentage	Double	Percentage of total distance driven in this context
durationPercentage	Double	Percentage of total duration driven in this context
consumedEnergyPercentage	Double	Percentage of total energy driven in this context

@Keep
data class DKRoadContextInfo(
    val roadContext: RoadContext,
    val distancePercentage: Double,
    val durationPercentage: Double,
    val consumedEnergyPercentage: Double
)

DKCommonTripType

DKCommonTripType indicates the type of trip.

Value	Description
MOST_FREQUENT	Most frequent trip
UNKNOWN	Unknown type for the SDK (if a new type is added but the SDK is not up to date)

@Keep
enum class DKCommonTripType {
    MOST_FREQUENT,
    UNKNOWN
}

DKCommonTrip

DKCommonTrip is an object providing information about a trip.

Attribute	Type	Description
type	DKCommonTripType	Type of trip
tripNumber	Int	Number of trips
distanceMean	Int	Average trip distance (in km)
durationMean	Int	Average trip duration (in min)
roadContext	RoadContext	Road context type

@Keep
data class DKCommonTrip(
    val type: DKCommonTripType,
    val tripNumber: Int,
    val distanceMean: Int,
    val durationMean: Int,
    val roadContext: RoadContext
)

DKMobilityAreaType

DKMobilityAreaType indicates the type of mobility area.

Value	Description
PERCENTILE_50TH	The radius including 50% of all the user’s trips
PERCENTILE_90TH	The radius including 90% of all the user’s trips

@Keep
enum class DKMobilityAreaType {
    PERCENTILE_50TH,
    PERCENTILE_90TH
}