GET api/v4/assetjourneysummary/{userID}/{token}/{assetID}/{from}/{to}

Request Information

URI Parameters

Name	Type	Additional information
userID	unsigned integer	Required
token	string	Required
assetID	unsigned integer	Required
from	string	Required
to	string	Required

Body Parameters

None.

Response Information

Resource Description

JourneySummaryAsset

Name	Description	Type	Additional information
AssetID	The ID of the asset which made the journey	unsigned integer	None.
ServiceID	The ID of the Service which made the journey	unsigned integer	None.
SummaryType	The type of the summary	JourneySummaryType	None.
StartDate	The start date of the summary	date	None.
EndDate	The end date of the summary	date	None.
FirstJourneyStartDate	The start date of the first journey	date	None.
LastJourneyEndDate	The end date of the last journey	date	None.
Duration	The duration of the all journeys in seconds	unsigned integer	None.
IdleTime	The journey idle time in seconds during all the journeys	unsigned integer	None.
MaxIdleInstance	The maximum period of idling during all the journeys	unsigned integer	None.
DistanceMeters	The distance traveled in meters during the journeys	unsigned integer	None.
StartLat	The start latitude of the first journey	decimal number	None.
StartLong	The start longitude of the first journey	decimal number	None.
StartStreet	The start street of the first journey	string	None.
StartTown	The start town of the first journey	string	None.
StartCountry	The start country of the first journey	string	None.
StartPOI	The start POI of the first journey	string	None.
StartPostcode	The start postcode of the first journey	string	None.
EndLat	The end latitude of the last journey	decimal number	None.
EndLong	The end longitude of the last journey	decimal number	None.
EndStreet	The end street of the last journey	string	None.
EndTown	The end town of the last journey	string	None.
EndCountry	The end country of the last journey	string	None.
EndPOI	The end POI of the last journey	string	None.
EndPostcode	The end post code of the last journey	string	None.
RpmEvents	The number of RPM events seen during the journeys	unsigned integer	None.
RpmMax	The maximum RPM value seen during the journeys	unsigned integer	None.
RpmLevel1Count	The number of RPM level 1 events during the journeys	unsigned integer	None.
RpmLevel2Count	The number of RPM level 2 events during the journeys	unsigned integer	None.
RpmLevel3Count	The number of RPM level 3 events during the journeys	unsigned integer	None.
RpmLevel4Count	The number of RPM level 4 events during the journeys	unsigned integer	None.
RpmLevel5Count	The number of RPM level 5 events during the journeys	unsigned integer	None.
RpmLevel6Count	The number of RPM level 6 events during the journeys	unsigned integer	None.
AccelEvents	The amount of acceleration events during the journeys	unsigned integer	None.
AccelMax	The maximum acceleration instance during the journeys	decimal number	None.
AccelLowCount	The amount of low level acceleration events during the journeys	unsigned integer	None.
AccelMediumCount	The amount of medium level acceleration events during the journeys	unsigned integer	None.
AccelHighCount	The amount of high level acceleration events during the journeys	unsigned integer	None.
DecelEvents	The amount of deceleration events during the journeys	unsigned integer	None.
DecelMax	The maximum deceleration instance during the journeys	decimal number	None.
DecelLowCount	The amount of low level deceleration events during the journeys	unsigned integer	None.
DecelMediumCount	The amount of medium level deceleration events during the journeys	unsigned integer	None.
DecelHighCount	The amount of high level deceleration events during the journeys	unsigned integer	None.
SpeedEvents	The number of speeding events during the journeys	unsigned integer	None.
SpeedMax	The maximum speed during the journeys	decimal number	None.
Speed15Count		unsigned integer	None.
Speed45Count		unsigned integer	None.
Speed55Count		unsigned integer	None.
Speed65Count		unsigned integer	None.
Speed20Count	The number of speeding events in 20 mph zones during the journeys	unsigned integer	None.
Speed30Count	The number of speeding events in 30 mph zones during the journeys	unsigned integer	None.
Speed40Count	The number of speeding events in 40 mph zones during the journeys	unsigned integer	None.
Speed50Count	The number of speeding events in 50 mph zones during the journeys	unsigned integer	None.
Speed60Count	The number of speeding events in 60 mph zones during the journeys	unsigned integer	None.
Speed70Count	The number of speeding events in 70 mph zones during the journeys	unsigned integer	None.
DeadzoneTime	The night time driving score in seconds during the journey	unsigned integer	None.
UrbanDistance	The urban distance driven during the journey	unsigned integer	None.
CO2	The CO2 used in the journey	decimal number	None.
Input0Distance	The distance driven with input 0 active	unsigned integer	None.
Input1Distance	The distance driven with input 1 active	unsigned integer	None.
Input2Distance	The distance driven with input 2 active	unsigned integer	None.
Input3Distance	The distance driven with input 3 active	unsigned integer	None.
Input0Duration	The duration in seconds when input 0 was active	unsigned integer	None.
Input1Duration	The duration in seconds when input 1 was active	unsigned integer	None.
Input2Duration	The duration in seconds when input 2 was active	unsigned integer	None.
Input3Duration	The duration in seconds when input 3 was active	unsigned integer	None.
ActionDistance	The distance driven with the action state active	unsigned integer	None.
ActionDuration	The duration in seconds when the action state was active	unsigned integer	None.
StartVoltage	The vehicle battery voltage at the start of the first journey	decimal number	None.
EndVoltage	The vehicle battery voltage at the end of the last journey	decimal number	None.
WaterUsed	Water used during the journeys if applicable	decimal number	None.
AreaCleaned	The area cleaned during the journeys if applicable	decimal number	None.
StartFuelPercentage	The start fuel percentage from the first journey	decimal number	None.
EndFuelPercentage	The end fuel percentage from the last journey	decimal number	None.
StartFuelLitre	The start fuel level from the first journey	decimal number	None.
EndFuelLitre	The end fuel level from the last journey	decimal number	None.
TotalFuelUsed	The fuel used in litres	decimal number	None.
JourneyCount	The number of journeys completed	unsigned integer	None.
IdlingJourneyCount	The number of journeys idling	unsigned integer	None.
MaximumJourneyDistance	The maximum journey distance in meters	unsigned integer	None.
MinimumJourneyDistance	The minimum journey distance in meters	unsigned integer	None.
MaximumJourneyDuration	The maximum journey duration in seconds	unsigned integer	None.
MinimumJourneyDuration	The minimum journey duration in seconds	unsigned integer	None.
ReportingAssets	if summarising for more than one vehicle, the count of vehicles that reported in during the selected time	integer	None.
Previous16WeeksWorkingTime	The total working time for the previous 16 weeks, this is only populated on weekly records	unsigned integer	None.
CurrentPeriodWorkingTime	The current period working time, this is only populated on the daily and weekly records	unsigned integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AssetID": 1,
  "ServiceID": 2,
  "SummaryType": 0,
  "StartDate": "2025-04-27T16:04:11.982423+00:00",
  "EndDate": "2025-04-27T16:04:11.982423+00:00",
  "FirstJourneyStartDate": "2025-04-27T16:04:11.982423+00:00",
  "LastJourneyEndDate": "2025-04-27T16:04:11.982423+00:00",
  "Duration": 7,
  "IdleTime": 8,
  "MaxIdleInstance": 9,
  "DistanceMeters": 10,
  "StartLat": 11.1,
  "StartLong": 12.1,
  "StartStreet": "sample string 13",
  "StartTown": "sample string 14",
  "StartCountry": "sample string 15",
  "StartPOI": "sample string 16",
  "StartPostcode": "sample string 17",
  "EndLat": 18.1,
  "EndLong": 19.1,
  "EndStreet": "sample string 20",
  "EndTown": "sample string 21",
  "EndCountry": "sample string 22",
  "EndPOI": "sample string 23",
  "EndPostcode": "sample string 24",
  "RpmEvents": 25,
  "RpmMax": 26,
  "RpmLevel1Count": 27,
  "RpmLevel2Count": 28,
  "RpmLevel3Count": 29,
  "RpmLevel4Count": 30,
  "RpmLevel5Count": 31,
  "RpmLevel6Count": 32,
  "AccelEvents": 33,
  "AccelMax": 34.1,
  "AccelLowCount": 35,
  "AccelMediumCount": 36,
  "AccelHighCount": 37,
  "DecelEvents": 38,
  "DecelMax": 39.1,
  "DecelLowCount": 40,
  "DecelMediumCount": 41,
  "DecelHighCount": 42,
  "SpeedEvents": 43,
  "SpeedMax": 44.1,
  "Speed15Count": 45,
  "Speed45Count": 46,
  "Speed55Count": 47,
  "Speed65Count": 48,
  "Speed20Count": 49,
  "Speed30Count": 50,
  "Speed40Count": 51,
  "Speed50Count": 52,
  "Speed60Count": 53,
  "Speed70Count": 54,
  "DeadzoneTime": 55,
  "UrbanDistance": 56,
  "CO2": 57.1,
  "Input0Distance": 58,
  "Input1Distance": 59,
  "Input2Distance": 60,
  "Input3Distance": 61,
  "Input0Duration": 62,
  "Input1Duration": 63,
  "Input2Duration": 64,
  "Input3Duration": 65,
  "ActionDistance": 66,
  "ActionDuration": 67,
  "StartVoltage": 68.1,
  "EndVoltage": 69.1,
  "WaterUsed": 70.1,
  "AreaCleaned": 71.1,
  "StartFuelPercentage": 72.1,
  "EndFuelPercentage": 73.1,
  "StartFuelLitre": 74.1,
  "EndFuelLitre": 75.1,
  "TotalFuelUsed": 76.1,
  "JourneyCount": 77,
  "IdlingJourneyCount": 78,
  "MaximumJourneyDistance": 79,
  "MinimumJourneyDistance": 80,
  "MaximumJourneyDuration": 81,
  "MinimumJourneyDuration": 82,
  "ReportingAssets": 83,
  "Previous16WeeksWorkingTime": 84,
  "CurrentPeriodWorkingTime": 85
}

application/xml, text/xml

Sample:

<JourneySummaryAsset xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AssetID>1</AssetID>
  <ServiceID>2</ServiceID>
  <SummaryType>daily</SummaryType>
  <StartDate>2025-04-27T16:04:11.982423+00:00</StartDate>
  <EndDate>2025-04-27T16:04:11.982423+00:00</EndDate>
  <FirstJourneyStartDate>2025-04-27T16:04:11.982423+00:00</FirstJourneyStartDate>
  <LastJourneyEndDate>2025-04-27T16:04:11.982423+00:00</LastJourneyEndDate>
  <Duration>7</Duration>
  <IdleTime>8</IdleTime>
  <MaxIdleInstance>9</MaxIdleInstance>
  <DistanceMeters>10</DistanceMeters>
  <StartLat>11.1</StartLat>
  <StartLong>12.1</StartLong>
  <StartStreet>sample string 13</StartStreet>
  <StartTown>sample string 14</StartTown>
  <StartCountry>sample string 15</StartCountry>
  <StartPOI>sample string 16</StartPOI>
  <StartPostcode>sample string 17</StartPostcode>
  <EndLat>18.1</EndLat>
  <EndLong>19.1</EndLong>
  <EndStreet>sample string 20</EndStreet>
  <EndTown>sample string 21</EndTown>
  <EndCountry>sample string 22</EndCountry>
  <EndPOI>sample string 23</EndPOI>
  <EndPostcode>sample string 24</EndPostcode>
  <RpmEvents>25</RpmEvents>
  <RpmMax>26</RpmMax>
  <RpmLevel1Count>27</RpmLevel1Count>
  <RpmLevel2Count>28</RpmLevel2Count>
  <RpmLevel3Count>29</RpmLevel3Count>
  <RpmLevel4Count>30</RpmLevel4Count>
  <RpmLevel5Count>31</RpmLevel5Count>
  <RpmLevel6Count>32</RpmLevel6Count>
  <AccelEvents>33</AccelEvents>
  <AccelMax>34.1</AccelMax>
  <AccelLowCount>35</AccelLowCount>
  <AccelMediumCount>36</AccelMediumCount>
  <AccelHighCount>37</AccelHighCount>
  <DecelEvents>38</DecelEvents>
  <DecelMax>39.1</DecelMax>
  <DecelLowCount>40</DecelLowCount>
  <DecelMediumCount>41</DecelMediumCount>
  <DecelHighCount>42</DecelHighCount>
  <SpeedEvents>43</SpeedEvents>
  <SpeedMax>44.1</SpeedMax>
  <Speed15Count>45</Speed15Count>
  <Speed45Count>46</Speed45Count>
  <Speed55Count>47</Speed55Count>
  <Speed65Count>48</Speed65Count>
  <Speed20Count>49</Speed20Count>
  <Speed30Count>50</Speed30Count>
  <Speed40Count>51</Speed40Count>
  <Speed50Count>52</Speed50Count>
  <Speed60Count>53</Speed60Count>
  <Speed70Count>54</Speed70Count>
  <DeadzoneTime>55</DeadzoneTime>
  <UrbanDistance>56</UrbanDistance>
  <CO2>57.1</CO2>
  <Input0Distance>58</Input0Distance>
  <Input1Distance>59</Input1Distance>
  <Input2Distance>60</Input2Distance>
  <Input3Distance>61</Input3Distance>
  <Input0Duration>62</Input0Duration>
  <Input1Duration>63</Input1Duration>
  <Input2Duration>64</Input2Duration>
  <Input3Duration>65</Input3Duration>
  <ActionDistance>66</ActionDistance>
  <ActionDuration>67</ActionDuration>
  <StartVoltage>68.1</StartVoltage>
  <EndVoltage>69.1</EndVoltage>
  <WaterUsed>70.1</WaterUsed>
  <AreaCleaned>71.1</AreaCleaned>
  <StartFuelPercentage>72.1</StartFuelPercentage>
  <EndFuelPercentage>73.1</EndFuelPercentage>
  <StartFuelLitre>74.1</StartFuelLitre>
  <EndFuelLitre>75.1</EndFuelLitre>
  <TotalFuelUsed>76.1</TotalFuelUsed>
  <JourneyCount>77</JourneyCount>
  <IdlingJourneyCount>78</IdlingJourneyCount>
  <MaximumJourneyDistance>79</MaximumJourneyDistance>
  <MinimumJourneyDistance>80</MinimumJourneyDistance>
  <MaximumJourneyDuration>81</MaximumJourneyDuration>
  <MinimumJourneyDuration>82</MinimumJourneyDuration>
  <ReportingAssets>83</ReportingAssets>
  <Previous16WeeksWorkingTime>84</Previous16WeeksWorkingTime>
  <CurrentPeriodWorkingTime>85</CurrentPeriodWorkingTime>
</JourneySummaryAsset>