1. Description
Ecodriving API is dedicated to output object’s or driver’s ecodriving data for requested period.
Solution description: New Eco driving module
2. Limitations
- 1000 req/min
- Maximum period is 92 days
- Period accuracy 1 minute.
3. Request parameters
3.1. Request by object
GET /ecodriving/object?id=<...>&version=<...>&api_key=<...>from_datetime=<...>&to_datetime=<...> HTTP/1.1 Host: api.fm-track.com Content-Type: application/json;charset=UTF-8
| Parameter | Type | Description | Is required | Remarks | |
|---|---|---|---|---|---|
| 1 | id | string | External object ID | + | |
| 2 | from_datetime | date time | Find events starting from specified date | + | example for format: "2017-04-13T06:58:48.090Z" according ISO-8601 |
| 3 | to_datetime | date time | Find events ending to specified date.Ê | + | example for format: "2017-04-13T06:58:48.090Z" according ISO-8601 |
| 6 | version | string | version of API | + | At this moment we have only version=1 |
| 7 | api_key | string | User identification key | + |
3.2. Request by driver
GET /ecodriving/driver?id=<...>&version=<...>&api_key=<...>from_datetime=<...>&to_datetime=<...> HTTP/1.1 Host: api.fm-track.com Content-Type: application/json;charset=UTF-8
| Parameter | Type | Description | Is required | Remarks | |
|---|---|---|---|---|---|
| 1 | id | string | External driver ID | + | |
| 2 | from_datetime | date time | Find events starting from specified date | + | example for format: "2017-04-13T06:58:48.090Z" according ISO-8601 |
| 3 | to_datetime | date time | Find events ending to specified date.Ê | + | example for format: "2017-04-13T06:58:48.090Z" according ISO-8601 |
| 6 | version | string | version of API | + | At this moment we have only version=1 |
| 7 | api_key | string | User identification key | + |
4. Response parameters
{
"subject_id": "6ad1f33",
"parameters": {
"main_parameters": {
"distance": 253.98,
"driving_duration": 24359391.00,
"fuel_consumed_count": 72.21,
"fuel_consumption_rate": 28.43,
"average_weight": 264.58,
"average_turning_angle": 16.92,
"average_gradient": 0.29,
"total_score": 37
},
"acceleration_parameters": {
"harsh_acceleration_event_count": 0.00,
"harsh_acceleration_event_rate": 0.00,
"maximum_acceleration": 0.93,
"acceleration_score": 100
},
"cornering_parameters": {
"cornering_rate": null,
"cornering_event_count": null,
"maximum_cornering": null
},
"cruise_control_parameters": {
"cruise_control_percentage": 61.05,
"cruise_control_was_on_duration": 3066.00,
"cruise_control_could_be_on_duration": 5022.00,
"cruise_control_could_be_on_distance": 107.76,
"cruise_control_was_on_distance": 3.59,
"cruise_control_distance": 0.00,
"cruise_control_fuel_consumed_count": 0.00,
"cruise_control_distance_percentage": 3.33,
"cruise_control_fuel_consumption_rate": 0.00,
"cruise_control_distance_from_all_distance_percentage": 0.00,
"cruise_control_score": 0,
"free_rolling_with_cruise_control_distance": 75725.00,
"free_rolling_with_cruise_control_fuel_consumed_count": 0.26,
"cruise_control_duration": 9000.00,
"cruise_control_with_accelerator_fuel_consumed_count": 16.60,
"cruise_control_with_accelerator_distance": 208000.00,
"cruise_control_with_accelerator_duration": 8400.00,
"free_rolling_with_cruise_control_fuel_consumption_rate": 0.00,
"free_rolling_with_cruise_control_distance_percentage": 222100.01,
"cruise_control_duration_percentage": 0.04,
"cruise_control_with_accelerator_fuel_consumption_rate": 0.01,
"cruise_control_with_accelerator_distance_percentage": 0.00,
"cruise_control_with_accelerator_duration_percentage": 664.00
},
"engine_parameters": {
"rpm_in_red_band_percentage": 0.00,
"rpm_in_red_band_distance_percentage": 0.00,
"maximum_rpm": 2202.00,
"rpm_in_red_band_duration": 0.00,
"rpm_in_green_band_distance": 0.00,
"rpm_in_red_band_distance": 0.00,
"rpm_range1_distance": 44.04,
"rpm_range1_fuel_consumed_count": 2.52,
"rpm_range2_distance": 9567.23,
"rpm_range2_fuel_consumed_count": 1042.47,
"rpm_range3_distance": 6154.36,
"rpm_range3_fuel_consumed_count": 432.13,
"rpm_range4_distance": 0.00,
"rpm_range4_fuel_consumed_count": 0.00,
"free_rolling_distance": 34.10,
"free_rolling_distance_percentage": 13.42,
"engine_overloaded_distance": 7552.04,
"engine_overloaded_fuel_consumed_count": 131.08,
"engine_overloaded_distance_percentage": 2973.48,
"engine_overloaded_fuel_consumption_rate": 1.74,
"highest_gear_distance_percentage": 0.00,
"highest_gear_fuel_consumption_rate": 0.00,
"highest_gear_distance": 0.00,
"highest_gear_fuel_consumed_count": 0.00,
"rpm_range1_consumption_rate": 5.71,
"rpm_range2_consumption_rate": 10.90,
"rpm_range3_consumption_rate": 7.02,
"rpm_range4_consumption_rate": 0.00,
"rpm_range1_distance_percentage": 17.34,
"rpm_range2_distance_percentage": 3766.92,
"rpm_range3_distance_percentage": 2423.17,
"rpm_range4_distance_percentage": 0.00,
"free_rolling_without_cruise_control_distance": 2432000.00,
"free_rolling_without_cruise_control_fuel_consumed_count": 180.22,
"free_rolling_without_cruise_control_fuel_consumption_rate": 0.01,
"free_rolling_without_cruise_control_distance_percentage": 7133010.71,
"engine_score": 67
},
"idling_parameters": {
"idling_duration": 16958503.00,
"excess_idling_percentage": 69.62,
"idling_fuel_consumed_count": 0.06,
"fuel_used_while_idling_percentage": 0.08,
"idling_score": 50
},
"speed_parameters": {
"average_speed": 0.04,
"maximum_speed": 92.00,
"overspeeding_duration": 102.00,
"overspeeding_percentage": 0.00,
"overspeeding_distance": 966.40,
"overspeeding_fuel_consumed_count": 380.35,
"normal_speed_distance": 368965852.67,
"overspeeding_distance_percentage": 380.50,
"overspeeding_fuel_consumption_rate": 39.36,
"speed_score": 0
},
"braking_parameters": {
"extreme_braking_event_count": null,
"extreme_braking_event_rate": null,
"braking_distance": 10.48,
"braking_duration": 565.00,
"engine_braking_distance": 0.00,
"retarder_duration": 270.00,
"maximum_braking": null,
"stops_rate": 9.06,
"normal_braking_stops_rate": null,
"braking_distance_percentage": 4.13,
"engine_braking_distance_percentage": 0.00,
"retarder_duration_percentage": 0.00,
"normal_braking_event_count": null,
"normal_braking_event_rate": null,
"harsh_braking_event_count": null,
"harsh_braking_event_rate": null,
"stops_event_count": 23.00,
"retarder_distance": 250.00,
"retarder_without_cruise_control_distance": 132864.00,
"parking_brake_abuse_event_count": 3.00,
"retarder_without_cruise_control_distance_percentage": 52312.78,
"retarder_distance_percentage": 98.43,
"parking_brake_abuse_rate": 1.18,
"braking_score": 5
}
}
}
| Name | Type | units | Description |
|---|---|---|---|
| subject_id | string | External object/driver ID | |
| parameters | array | Container for ecodriving parameters | |
| main_parameters | array | Container for main ecodriving parameters | |
| distance | number | KM | Driven distance |
| driving_duration | number | time | Engine on duration. |
| fuel_consumed_count | number | L | Total amount of fuel consumed |
| fuel_consumption_rate | number | L/100 KM | Fuel consumed per 100 km |
| average_weight | number | t | Average weight by selected period. |
| average_turning_angle | number | degree | Average turning angle by kilometer for selected period |
| average_gradient | number | degree | Average turning gradient by kilometer for selected period |
| total_score | number | Evaluation of object/driver | |
| acceleration_parameters | array | Container for acceleration ecodriving parameters | |
| harsh_acceleration_event_count | number | event | Harsh acceleration events (registered, when braking acceleration exceeds configured limit). |
| harsh_acceleration_event_rate | number | events/100 KM | The average amount of harsh acceleration events per 100 km is shown in brackets |
| maximum_acceleration | number | m/ss | Maximum acceleration value |
| acceleration_score | number | Evaluation of acceleration | |
| cornering_parameters | array | Container for cornering ecodriving parameters | |
| cornering_rate | number | event | Number of cornering events, when the cornering acceleration exceeds configured limit. |
| cornering_event_count | number | events/100 KM | Number of cornering events per 100 km |
| maximum_cornering | number | m/ss | Maximum cornering value |
| cruise_control_parameters | array | Container for cruise control ecodriving parameters | |
| cruise_control_percentage | number | number | Shows the percentage of hours of used cruise control, when cruise control could be used. (If cruise control was used all the time, it could be used; the parameter would be 100 %). The speed, defining it's time to use cruise control is configurable parameter. |
| cruise_control_could_be_on_duration | number | time | Time when, cruise control could be on when speed is above threshold (configurable) for longer than 60 seconds. |
| cruise_control_was_on_duration | number | time | Time when, cruise control was on and speed is above threshold (configurable) for longer than 60 seconds. |
| cruise_control_could_be_on_distance | number | KM | Distance when, cruise control could be on when speed is above threshold (configurable) for longer than 60 seconds. |
| cruise_control_was_on_distance | number | KM | Distance when, cruise control was on and speed is above threshold (configurable) for longer than 60 seconds. |
| cruise_control_distance | number | KM | Distance when cruise control was on. |
| cruise_control_fuel_consumed_count | number | L | Fuel used when cruise control was on. |
| cruise_control_distance_percentage | number | % | Shows the percentage of distance of used cruise control, when cruise control could be used. |
| cruise_control_fuel_consumption_rate | number | L/100 KM | Fuel consumption when cruise control was on |
| cruise_control_distance_from_all_distance_percentage | number | % | Percentage of distance when cruise control was on. |
| cruise_control_score | number | Evaluation of cruise control usage | |
| free_rolling_with_cruise_control_distance | number | KM | Distance, when Cruise control is ON, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable). |
| free_rolling_with_cruise_control_fuel_consumed_count | number | L | Fuel used when Cruise control is ON, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable), CAN Wheel based speed >0 km/h |
| cruise_control_duration | number | time | Time when Cruise control was on |
| cruise_control_with_accelerator_fuel_consumed_count | number | L | Fuel used when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| cruise_control_with_accelerator_distance | number | KM | Distance when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| cruise_control_with_accelerator_duration | number | time | Time when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| free_rolling_with_cruise_control_fuel_consumption_rate | number | L/100 KM | Fuel consumption when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable), CAN Wheel based speed >0 km/h |
| free_rolling_with_cruise_control_distance_percentage | number | % | The percentage of free rolling distance, when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable). |
| cruise_control_duration_percentage | number | % | Percentage of time when Cruise control was on |
| cruise_control_with_accelerator_fuel_consumption_rate | number | L/100 KM | Fuel consumption when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| cruise_control_with_accelerator_distance_percentage | number | % | Percentage of cruise control distance when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| cruise_control_with_accelerator_duration_percentage | number | % | Percentae of cruise control time when Engine is ON, Cruise control is ON, Throttle position sensor is above configured limit |
| engine_parameters | array | Container for engine ecodriving parameters | |
| rpm_in_red_band_duration | number | time | Duration, when the RPM value was out of the acceptable range (RPM range is configurable). |
| rpm_in_red_band_percentage | number | % | The percentage of driving time, when vehicle was operated in RPM red band. |
| maximum_rpm | number | Maximum RPM | |
| rpm_in_green_band_distance | number | KM | Distance, when the RPM value was in the acceptable range (RPM range is configurable). |
| rpm_in_red_band_distance | number | KM | Distance, when the RPM value was out of the acceptable range (RPM range is configurable). |
| rpm_in_red_band_distance_percentage | number | % | The percentage of distance, when the RPM value was out of the acceptable range. |
| rpm_range1_distance | number | KM | Distance , while vehicle's engine was running in RPM range 1 (RPM range is configurable). |
| rpm_range1_fuel_consumed_count | number | L | Fuel used, while vehicle's engine was running in RPM range 1 (RPM range is configurable). |
| rpm_range2_distance | number | KM | Distance , while vehicle's engine was running in RPM range 2 (RPM range is configurable). |
| rpm_range2_fuel_consumed_count | number | L | Fuel used, while vehicle's engine was running in RPM range 2 (RPM range is configurable). |
| rpm_range3_distance | number | KM | Distance , while vehicle's engine was running in RPM range 3 (RPM range is configurable). |
| rpm_range3_fuel_consumed_count | number | L | Fuel used, while vehicle's engine was running in RPM range 3 (RPM range is configurable). |
| rpm_range4_distance | number | KM | Distance , while vehicle's engine was running in RPM range 4 (RPM range is configurable). |
| rpm_range4_fuel_consumed_count | number | L | Fuel used, while vehicle's engine was running in RPM range 4 (RPM range is configurable). |
| free_rolling_distance | number | KM | Distance, while vehicle was free-rolling (engine on, accelerator pedal off (0%), RPM in range 450-650 (configurable)) |
| engine_overloaded_distance | number | KM | Distance, when the engine percent load parameter is above the threshold (configurable). |
| engine_overloaded_fuel_consumed_count | number | L | Fuel used, when the engine percent load parameter is above the threshold (configurable). |
| highest_gear_distance | number | KM | Distance when vehicle's speed exceeds configured "the highest gear speed" |
| highest_gear_fuel_consumed_count | number | L | Fuel used when vehicle's speed exceeds configured "the highest gear speed" |
| rpm_range1_consumption_rate | number | L/100 KM | Fuel consumption, while vehicle's engine was running in RPM range 1 |
| rpm_range2_consumption_rate | number | L/100 KM | Fuel consumption, while vehicle's engine was running in RPM range 2 |
| rpm_range3_consumption_rate | number | L/100 KM | Fuel consumption, while vehicle's engine was running in RPM range 3 |
| rpm_range4_consumption_rate | number | L/100 KM | Fuel consumption, while vehicle's engine was running in RPM range 4 |
| rpm_range1_distance_percentage | number | % | The percentage of distance, while vehicle's engine was running in RPM range 1 |
| rpm_range2_distance_percentage | number | % | The percentage of distance, while vehicle's engine was running in RPM range 2 |
| rpm_range3_distance_percentage | number | % | The percentage of distance, while vehicle's engine was running in RPM range 3 |
| rpm_range4_distance_percentage | number | % | The percentage of distance, while vehicle's engine was running in RPM range 4 |
| free_rolling_distance_percentage | number | % | The percentage of distance, while vehicle was free-rolling |
| engine_overloaded_distance_percentage | number | % | The percentage of distance, when the engine percent load parameter is above the threshold. |
| highest_gear_distance_percentage | number | % | The percentage of distance when vehicle's speed exceeds configured "the highest gear speed" |
| engine_overloaded_fuel_consumption_rate | number | L/100 KM | Fuel consumption when the engine percent load parameter is above the threshold. |
| highest_gear_fuel_consumption_rate | number | L/100 KM | Fuel consumption when vehicle's speed exceeds configured "the highest gear speed" |
| free_rolling_without_cruise_control_distance | number | KM | Distance, when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable). |
| free_rolling_without_cruise_control_fuel_consumed_count | number | L | Fuel used when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable), CAN Wheel based speed >0 km/h |
| free_rolling_without_cruise_control_fuel_consumption_rate | number | L/100 KM | Fuel consumption when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable), CAN Wheel based speed >0 km/h |
| free_rolling_without_cruise_control_distance_percentage | number | % | Fuel consumption when Cruise control is OFF, Engine is ON, Throttle position is 0, RPM is in the Free rolling RPM range (configurable), CAN Wheel based speed >0 km/h |
| engine_score | number | Evaluation of engine usage | |
| idling_parameters | array | Container for idling ecodriving parameters | |
| idling_duration | number | time | Idling time (when the engine is on for a certain duration (configurable) and vehicle's speed is lower than the threshold (configurable) |
| excess_idling_percentage | number | number | Shows the percentage of driving time, when vehicle was idling |
| idling_fuel_consumed_count | number | L | Fuel used while idling |
| fuel_used_while_idling_percentage | number | % | Percentage of fuel what was used while idling |
| idling_score | number | Evaluation of idling | |
| speed_parameters | array | Container for speed ecodriving parameters | |
| average_speed | number | KM | Average speed |
| maximum_speed | number | KM | Maximum speed |
| overspeeding_duration | number | time | Duration, when the vehicle was over speeding (speed limit is configurable). |
| overspeeding_percentage | number | % | The percentage of driving time, when vehicle was over speeding. |
| overspeeding_distance | number | KM | Distance , while vehicle was over speeding(speed limit is configurable). |
| overspeeding_distance_percentage | number | KM | The percentage of distance, while vehicle was over speeding. |
| overspeeding_fuel_consumed_count | number | L | Fuel used, while vehicle was over speeding(speed limit is configurable). |
| overspeeding_fuel_consumption_rate | number | L/100 KM | Fuel consumption, while vehicle was over speeding. |
| normal_speed_distance | number | KM | Distance, when vehicle's speed was below the speed limit (speed limit is configurable). |
| speed_score | number | Evaluation of speed | |
| braking_parameters | array | Container for braking ecodriving parameters | |
| extreme_braking_event_count | number | events | Extreme braking events (registered, when braking acceleration exceeds configured limit). |
| extreme_braking_event_rate | number | events/100 KM | The average amount of extreme braking events per 100 km. |
| harsh_breaking_event_count | number | events | Harsh braking events (registered, when braking acceleration exceeds configured limit). |
| harsh_breaking_event_rate | number | events/100 KM | The average amount of harsh braking events per 100 km. |
| normal_braking_event_count | number | events | Normal braking events |
| normal_braking_event_rate | number | events/100 KM | The average amount of normal braking events per 100 km. |
| maximum_braking | number | m/ss | Maximum braking value |
| braking_distance | number | KM | Distance, travelled while brake pedal was pressed |
| braking_duration | number | time | Time period when brake pedal was pressed and vehicle speed was not 0 |
| engine_braking_distance | number | KM | Distance while speed was above configurable threshold, fuel rate below configurable threshold and RPM above configurable threshold. |
| retarder_duration | number | time | Time period when retarder torque mode was not 0. |
| stops_event_count | number | events | Number of vehicle stops |
| stops_rate | number | events/100 KM | Number of vehicle stops per 100 km |
| normal_braking_stops_rate | number | Normal braking events and stops rate | |
| braking_distance_percentage | number | % | The percentage of distance, travelled while brake pedal was pressed |
| engine_braking_distance_percentage | number | % | The percentage of distance while speed was above configurable threshold, fuel rate below configurable threshold and RPM above configurable threshold. |
| retarder_duration_percentage | number | % | Percentage of driving time when retarder torque mode was not 0 |
| retarder_distance | number | KM | Distance when retarder torque was above zero. |
| retarder_without_cruise_control_distance | number | KM | Distance when retarder torque was above zero and cruise control was OFF. |
| parking_brake_abuse_event_count | number | events | Notification of the following event: CAN wheel based speed >= Parking brake abuse limit, Parking brake switch state = 1 |
| retarder_without_cruise_control_distance_percentage | number | % | Percentage of retarder without cruise control distance |
| retarder_distance_percentage | number | % | Percentage of retarder distance |
| parking_brake_abuse_rate | number | events/100 KM | Parking brake abuse rate |
| braking_score | number | Evaluation of braking |