GET apioauth/v5/vehiclescore/{serviceIDList}/{scoreType}/{scorePeriod}/{from}/{to}

Get vehicle score

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceIDList	A comma separated list of service IDs being queried eg 12553,19247,98672,458	string	Required
scoreType	The type of score being queried	ScoreType	Required
scorePeriod	The period of score being queried	ScorePeriod	Required
from	The start date being queried yyyyMMddHHmmss	string	Required
to	The end date being queried yyyyMMddHHmmss	string	Required

Body Parameters

None.

Response Information

Resource Description

A list of VehicleScores

Collection of VehicleScore

Name	Description	Type	Additional information
sys_service_id	The service ID of the score	unsigned integer	None.
score_period	The period of the score	ScorePeriod	None.
score_type	The type of the score	ScoreType	None.
sys_service_id_type_period	The hash used in dynamoDB	string	None.
start_date	The start date of this scoring period	date	None.
end_date	The end date of this scoring period	date	None.
last_journey_end_time	The end time of the last journey in this scoring period	date	None.
journey_count	The number of journeys taken into account in this score	unsigned integer	None.
distance	The distance traveled in meters for this score period	unsigned integer	None.
duration	The duration of travel in seconds for this score period	unsigned integer	None.
overall_score	The overall score for the score_type	unsigned integer	None.
urban_score	The overall night time score	unsigned integer	None.
urban_distance	The distance traveled in meters on urban roads in this score period	unsigned integer	None.
urban_duration	The duration of travel in seconds on urban roads in this score period	unsigned integer	None.
night_time_score	The overall night time score	unsigned integer	None.
night_time_distance	The distance traveled in meters on night time roads	unsigned integer	None.
night_time_duration	The duration of travel in seconds at night time in this score period	unsigned integer	None.
idling_score	The idling score	unsigned integer	None.
idling_duration	The duration in seconds of idling in this score period	unsigned integer	None.
longest_idling_instance	The duration of the longest single idling instance in seconds in this score period	unsigned integer	None.
speed_ideal	The ideal road speed in mph	decimal number	None.
speed_exceeded	The number of mph the speed was exceeded by	decimal number	None.
speed_score	The speeding score	unsigned integer	None.
speeding_event_count	The number of speeding events in this scoring period	unsigned integer	None.
speeding_duration	The time spent speeding in seconds	unsigned integer	None.
max_speed	The maximum speed observed during this scoring period	decimal number	None.
speed_15_count		unsigned integer	None.
speed_45_count		unsigned integer	None.
speed_55_count		unsigned integer	None.
speed_65_count		unsigned integer	None.
speed_20_count	The number of speeding events in a 20 mph zone	unsigned integer	None.
speed_30_count	The number of speeding events in a 30 mph zone	unsigned integer	None.
speed_40_count	The number of speeding events in a 40 mph zone	unsigned integer	None.
speed_50_count	The number of speeding events in a 50 mph zone	unsigned integer	None.
speed_60_count	The number of speeding events in a 60 mph zone	unsigned integer	None.
speed_70_count	The number of speeding events in a 70 mph zone	unsigned integer	None.
acceleration_score	The acceleration score	unsigned integer	None.
acceleration_event_count	The total acceleration events	unsigned integer	None.
acceleration_level_1_events	The total number of level 1 acceleration events	unsigned integer	None.
acceleration_level_2_events	The total number of level 2 acceleration events	unsigned integer	None.
acceleration_level_3_events	The total number of level 3 acceleration events	unsigned integer	None.
acceleration_max	The maximum acceleration in kilometers per hour per seconds seen in this scoring period	decimal number	None.
deceleration_score	The deceleration score	unsigned integer	None.
deceleration_event_count	The total deceleration events	unsigned integer	None.
deceleration_level_1_events	The total number of level 1 deceleration events	unsigned integer	None.
deceleration_level_2_events	The total number of level 2 deceleration events	unsigned integer	None.
deceleration_level_3_events	The total number of level 3 deceleration events	unsigned integer	None.
deceleration_max	The maximum deceleration in kilometers per hour per seconds seen in this scoring period	decimal number	None.
local_start_date	The local start date of a journey score	date	None.
local_end_date	The local end date of a journey score	date	None.
timezone	The timezone the journey ended in for a journey score	string	None.
idling_event_count	The number of idling events	unsigned integer	None.
extended_idling_event_count	The number of extended idling events	unsigned integer	None.
distance_score	The distance score	unsigned integer	None.
high_distance_journeys	Number of high distance journeys	unsigned integer	None.
low_distance_journeys	Number of low distance journeys	unsigned integer	None.
combined_distance	The combined distance traveled	unsigned integer	None.
extra_urban_distance	The extra urban distance traveled	unsigned integer	None.
ideal_fuel_used	The fuel used in litre if the fuel score was 100 percent	decimal number	None.
actual_fuel_used	The actual fuel used in litre when taking the score into account	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "sys_service_id": 1,
    "score_period": 0,
    "score_type": 0,
    "sys_service_id_type_period": "sample string 2",
    "start_date": "2026-04-03T21:52:15.6063066+00:00",
    "end_date": "2026-04-03T21:52:15.6063066+00:00",
    "last_journey_end_time": "2026-04-03T21:52:15.6063066+00:00",
    "journey_count": 6,
    "distance": 7,
    "duration": 8,
    "overall_score": 9,
    "urban_score": 10,
    "urban_distance": 11,
    "urban_duration": 12,
    "night_time_score": 13,
    "night_time_distance": 14,
    "night_time_duration": 15,
    "idling_score": 16,
    "idling_duration": 17,
    "longest_idling_instance": 18,
    "speed_ideal": 19.1,
    "speed_exceeded": 20.1,
    "speed_score": 21,
    "speeding_event_count": 22,
    "speeding_duration": 23,
    "max_speed": 24.1,
    "speed_15_count": 25,
    "speed_45_count": 26,
    "speed_55_count": 27,
    "speed_65_count": 28,
    "speed_20_count": 29,
    "speed_30_count": 30,
    "speed_40_count": 31,
    "speed_50_count": 32,
    "speed_60_count": 33,
    "speed_70_count": 34,
    "acceleration_score": 35,
    "acceleration_event_count": 36,
    "acceleration_level_1_events": 37,
    "acceleration_level_2_events": 38,
    "acceleration_level_3_events": 39,
    "acceleration_max": 40.1,
    "deceleration_score": 41,
    "deceleration_event_count": 42,
    "deceleration_level_1_events": 43,
    "deceleration_level_2_events": 44,
    "deceleration_level_3_events": 45,
    "deceleration_max": 46.1,
    "local_start_date": "2026-04-03T21:52:15.6063066+00:00",
    "local_end_date": "2026-04-03T21:52:15.6063066+00:00",
    "timezone": "sample string 49",
    "idling_event_count": 50,
    "extended_idling_event_count": 51,
    "distance_score": 52,
    "high_distance_journeys": 53,
    "low_distance_journeys": 54,
    "combined_distance": 55,
    "extra_urban_distance": 56,
    "ideal_fuel_used": 57.1,
    "actual_fuel_used": 58.1
  },
  {
    "sys_service_id": 1,
    "score_period": 0,
    "score_type": 0,
    "sys_service_id_type_period": "sample string 2",
    "start_date": "2026-04-03T21:52:15.6063066+00:00",
    "end_date": "2026-04-03T21:52:15.6063066+00:00",
    "last_journey_end_time": "2026-04-03T21:52:15.6063066+00:00",
    "journey_count": 6,
    "distance": 7,
    "duration": 8,
    "overall_score": 9,
    "urban_score": 10,
    "urban_distance": 11,
    "urban_duration": 12,
    "night_time_score": 13,
    "night_time_distance": 14,
    "night_time_duration": 15,
    "idling_score": 16,
    "idling_duration": 17,
    "longest_idling_instance": 18,
    "speed_ideal": 19.1,
    "speed_exceeded": 20.1,
    "speed_score": 21,
    "speeding_event_count": 22,
    "speeding_duration": 23,
    "max_speed": 24.1,
    "speed_15_count": 25,
    "speed_45_count": 26,
    "speed_55_count": 27,
    "speed_65_count": 28,
    "speed_20_count": 29,
    "speed_30_count": 30,
    "speed_40_count": 31,
    "speed_50_count": 32,
    "speed_60_count": 33,
    "speed_70_count": 34,
    "acceleration_score": 35,
    "acceleration_event_count": 36,
    "acceleration_level_1_events": 37,
    "acceleration_level_2_events": 38,
    "acceleration_level_3_events": 39,
    "acceleration_max": 40.1,
    "deceleration_score": 41,
    "deceleration_event_count": 42,
    "deceleration_level_1_events": 43,
    "deceleration_level_2_events": 44,
    "deceleration_level_3_events": 45,
    "deceleration_max": 46.1,
    "local_start_date": "2026-04-03T21:52:15.6063066+00:00",
    "local_end_date": "2026-04-03T21:52:15.6063066+00:00",
    "timezone": "sample string 49",
    "idling_event_count": 50,
    "extended_idling_event_count": 51,
    "distance_score": 52,
    "high_distance_journeys": 53,
    "low_distance_journeys": 54,
    "combined_distance": 55,
    "extra_urban_distance": 56,
    "ideal_fuel_used": 57.1,
    "actual_fuel_used": 58.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfVehicleScore xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VehicleScore>
    <sys_service_id>1</sys_service_id>
    <score_period>journey</score_period>
    <score_type>fuel</score_type>
    <sys_service_id_type_period>sample string 2</sys_service_id_type_period>
    <start_date>2026-04-03T21:52:15.6063066+00:00</start_date>
    <end_date>2026-04-03T21:52:15.6063066+00:00</end_date>
    <last_journey_end_time>2026-04-03T21:52:15.6063066+00:00</last_journey_end_time>
    <journey_count>6</journey_count>
    <distance>7</distance>
    <duration>8</duration>
    <overall_score>9</overall_score>
    <urban_score>10</urban_score>
    <urban_distance>11</urban_distance>
    <urban_duration>12</urban_duration>
    <night_time_score>13</night_time_score>
    <night_time_distance>14</night_time_distance>
    <night_time_duration>15</night_time_duration>
    <idling_score>16</idling_score>
    <idling_duration>17</idling_duration>
    <longest_idling_instance>18</longest_idling_instance>
    <speed_ideal>19.1</speed_ideal>
    <speed_exceeded>20.1</speed_exceeded>
    <speed_score>21</speed_score>
    <speeding_event_count>22</speeding_event_count>
    <speeding_duration>23</speeding_duration>
    <max_speed>24.1</max_speed>
    <speed_15_count>25</speed_15_count>
    <speed_45_count>26</speed_45_count>
    <speed_55_count>27</speed_55_count>
    <speed_65_count>28</speed_65_count>
    <speed_20_count>29</speed_20_count>
    <speed_30_count>30</speed_30_count>
    <speed_40_count>31</speed_40_count>
    <speed_50_count>32</speed_50_count>
    <speed_60_count>33</speed_60_count>
    <speed_70_count>34</speed_70_count>
    <acceleration_score>35</acceleration_score>
    <acceleration_event_count>36</acceleration_event_count>
    <acceleration_level_1_events>37</acceleration_level_1_events>
    <acceleration_level_2_events>38</acceleration_level_2_events>
    <acceleration_level_3_events>39</acceleration_level_3_events>
    <acceleration_max>40.1</acceleration_max>
    <deceleration_score>41</deceleration_score>
    <deceleration_event_count>42</deceleration_event_count>
    <deceleration_level_1_events>43</deceleration_level_1_events>
    <deceleration_level_2_events>44</deceleration_level_2_events>
    <deceleration_level_3_events>45</deceleration_level_3_events>
    <deceleration_max>46.1</deceleration_max>
    <local_start_date>2026-04-03T21:52:15.6063066+00:00</local_start_date>
    <local_end_date>2026-04-03T21:52:15.6063066+00:00</local_end_date>
    <timezone>sample string 49</timezone>
    <idling_event_count>50</idling_event_count>
    <extended_idling_event_count>51</extended_idling_event_count>
    <distance_score>52</distance_score>
    <high_distance_journeys>53</high_distance_journeys>
    <low_distance_journeys>54</low_distance_journeys>
    <combined_distance>55</combined_distance>
    <extra_urban_distance>56</extra_urban_distance>
    <ideal_fuel_used>57.1</ideal_fuel_used>
    <actual_fuel_used>58.1</actual_fuel_used>
  </VehicleScore>
  <VehicleScore>
    <sys_service_id>1</sys_service_id>
    <score_period>journey</score_period>
    <score_type>fuel</score_type>
    <sys_service_id_type_period>sample string 2</sys_service_id_type_period>
    <start_date>2026-04-03T21:52:15.6063066+00:00</start_date>
    <end_date>2026-04-03T21:52:15.6063066+00:00</end_date>
    <last_journey_end_time>2026-04-03T21:52:15.6063066+00:00</last_journey_end_time>
    <journey_count>6</journey_count>
    <distance>7</distance>
    <duration>8</duration>
    <overall_score>9</overall_score>
    <urban_score>10</urban_score>
    <urban_distance>11</urban_distance>
    <urban_duration>12</urban_duration>
    <night_time_score>13</night_time_score>
    <night_time_distance>14</night_time_distance>
    <night_time_duration>15</night_time_duration>
    <idling_score>16</idling_score>
    <idling_duration>17</idling_duration>
    <longest_idling_instance>18</longest_idling_instance>
    <speed_ideal>19.1</speed_ideal>
    <speed_exceeded>20.1</speed_exceeded>
    <speed_score>21</speed_score>
    <speeding_event_count>22</speeding_event_count>
    <speeding_duration>23</speeding_duration>
    <max_speed>24.1</max_speed>
    <speed_15_count>25</speed_15_count>
    <speed_45_count>26</speed_45_count>
    <speed_55_count>27</speed_55_count>
    <speed_65_count>28</speed_65_count>
    <speed_20_count>29</speed_20_count>
    <speed_30_count>30</speed_30_count>
    <speed_40_count>31</speed_40_count>
    <speed_50_count>32</speed_50_count>
    <speed_60_count>33</speed_60_count>
    <speed_70_count>34</speed_70_count>
    <acceleration_score>35</acceleration_score>
    <acceleration_event_count>36</acceleration_event_count>
    <acceleration_level_1_events>37</acceleration_level_1_events>
    <acceleration_level_2_events>38</acceleration_level_2_events>
    <acceleration_level_3_events>39</acceleration_level_3_events>
    <acceleration_max>40.1</acceleration_max>
    <deceleration_score>41</deceleration_score>
    <deceleration_event_count>42</deceleration_event_count>
    <deceleration_level_1_events>43</deceleration_level_1_events>
    <deceleration_level_2_events>44</deceleration_level_2_events>
    <deceleration_level_3_events>45</deceleration_level_3_events>
    <deceleration_max>46.1</deceleration_max>
    <local_start_date>2026-04-03T21:52:15.6063066+00:00</local_start_date>
    <local_end_date>2026-04-03T21:52:15.6063066+00:00</local_end_date>
    <timezone>sample string 49</timezone>
    <idling_event_count>50</idling_event_count>
    <extended_idling_event_count>51</extended_idling_event_count>
    <distance_score>52</distance_score>
    <high_distance_journeys>53</high_distance_journeys>
    <low_distance_journeys>54</low_distance_journeys>
    <combined_distance>55</combined_distance>
    <extra_urban_distance>56</extra_urban_distance>
    <ideal_fuel_used>57.1</ideal_fuel_used>
    <actual_fuel_used>58.1</actual_fuel_used>
  </VehicleScore>
</ArrayOfVehicleScore>