POST apioauth/v4/journeysummary

Get summarised journey information. Note times must start at 00:00:00 to ensure the desired start day is covered

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
StartDate	The start date being queried	date	None.
EndDate	The end date being queried	date	None.
ServiceIDList	A list of service ids being requested	Collection of unsigned integer	None.

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2025-11-04T14:29:34.1117984+00:00",
  "EndDate": "2025-11-04T14:29:34.1117984+00:00",
  "ServiceIDList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<OAuthSummarisedJourneyRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartDate>2025-11-04T14:29:34.1117984+00:00</StartDate>
  <EndDate>2025-11-04T14:29:34.1117984+00:00</EndDate>
  <ServiceIDList>
    <unsignedLong>1</unsignedLong>
    <unsignedLong>2</unsignedLong>
  </ServiceIDList>
</OAuthSummarisedJourneyRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of SummerisedJourneyDetails

Collection of SummerisedJourneyDetails

Name	Description	Type	Additional information
FirstJourneyStartDate	The first journey start date	date	None.
LastJourneyEndDate	The last journey end date	date	None.
serviceId	The service id of the unit	unsigned integer	None.
accelMax	The maximum acceleration level reached in km per hour per second	decimal number	None.
accelEventCount	The total number of harsh acceleration events	integer	None.
accelHighEventCount	The total number of high level acceleration events	integer	None.
accelMediumEventCount	The total number of medium level acceleration events	integer	None.
accelLowEventCount	The total number of low level acceleration events	integer	None.
actionDistance	The distance traveled in meters with action flag set	integer	None.
actionDuration	The duration traveled in seconds with the action flag set	integer	None.
decelMax	The maximum deceleration level reached in km per hour per second	decimal number	None.
decelEventCount	The total number of harsh deceleration events	integer	None.
decelHighEventCount	The total number of high level deceleration events	integer	None.
decelMediumEventCount	The total number of medium level deceleration events	integer	None.
decelLowEventCount	The total number of low level deceleration events	integer	None.
distance	The distance traveled in meters	decimal number	None.
duration	The total duration of journeys in seconds	integer	None.
idleTime	The total duration of idling in seconds	integer	None.
longestIdlingInstance	The longest single instance of idling in seconds	integer	None.
input0Distance	The distance traveled in meters with input 0 active	integer	None.
input0Duration	The duration traveled in seconds with input 0 active	integer	None.
input1Distance	The distance traveled in meters with input 1 active	integer	None.
input1Duration	The duration traveled in seconds with input 1 active	integer	None.
input2Distance	The distance traveled in meters with input 2 active	integer	None.
input2Duration	The duration traveled in seconds with input 2 active	integer	None.
input3Distance	The distance traveled in meters with input 3 active	integer	None.
input3Duration	The duration traveled in seconds with input 3 active	integer	None.
maxSpeed	The maximum speed seen in mph	decimal number	None.
rpmEventsCount	The total number of harsh RPM events	integer	None.
rpmEventsLevel1Count	The total number of level 1 harsh RPM events	integer	None.
rpmEventsLevel2Count	The total number of level 2 harsh RPM events	integer	None.
rpmEventsLevel3Count	The total number of level 3 harsh RPM events	integer	None.
rpmEventsLevel4Count	The total number of level 4 harsh RPM events	integer	None.
rpmEventsLevel5Count	The total number of level 5 harsh RPM events	integer	None.
rpmEventsLevel6Count	The total number of level 6 harsh RPM events	integer	None.
rpmMax	The maximum RPM level seen	integer	None.
speed20Count	The number of speeding events in 20mph zones	integer	None.
speed30Count	The number of speeding events in 30mph zones	integer	None.
speed40Count	The number of speeding events in 40mph zones	integer	None.
speed50Count	The number of speeding events in 50mph zones	integer	None.
speed60Count	The number of speeding events in 60mph zones	integer	None.
speed70Count	The number of speeding events in 70mph zones	integer	None.
speedEvents	The total number of speeding events	integer	None.
journeyCount	The number of journeys completed	unsigned integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "FirstJourneyStartDate": "2025-11-04T14:29:34.1117984+00:00",
    "LastJourneyEndDate": "2025-11-04T14:29:34.1117984+00:00",
    "serviceId": 3,
    "accelMax": 4.1,
    "accelEventCount": 5,
    "accelHighEventCount": 6,
    "accelMediumEventCount": 7,
    "accelLowEventCount": 8,
    "actionDistance": 9,
    "actionDuration": 10,
    "decelMax": 11.1,
    "decelEventCount": 12,
    "decelHighEventCount": 13,
    "decelMediumEventCount": 14,
    "decelLowEventCount": 15,
    "distance": 16.1,
    "duration": 17,
    "idleTime": 18,
    "longestIdlingInstance": 19,
    "input0Distance": 20,
    "input0Duration": 21,
    "input1Distance": 22,
    "input1Duration": 23,
    "input2Distance": 24,
    "input2Duration": 25,
    "input3Distance": 26,
    "input3Duration": 27,
    "maxSpeed": 28.1,
    "rpmEventsCount": 29,
    "rpmEventsLevel1Count": 30,
    "rpmEventsLevel2Count": 31,
    "rpmEventsLevel3Count": 32,
    "rpmEventsLevel4Count": 33,
    "rpmEventsLevel5Count": 34,
    "rpmEventsLevel6Count": 35,
    "rpmMax": 36,
    "speed20Count": 37,
    "speed30Count": 38,
    "speed40Count": 39,
    "speed50Count": 40,
    "speed60Count": 41,
    "speed70Count": 42,
    "speedEvents": 43,
    "journeyCount": 44
  },
  {
    "FirstJourneyStartDate": "2025-11-04T14:29:34.1117984+00:00",
    "LastJourneyEndDate": "2025-11-04T14:29:34.1117984+00:00",
    "serviceId": 3,
    "accelMax": 4.1,
    "accelEventCount": 5,
    "accelHighEventCount": 6,
    "accelMediumEventCount": 7,
    "accelLowEventCount": 8,
    "actionDistance": 9,
    "actionDuration": 10,
    "decelMax": 11.1,
    "decelEventCount": 12,
    "decelHighEventCount": 13,
    "decelMediumEventCount": 14,
    "decelLowEventCount": 15,
    "distance": 16.1,
    "duration": 17,
    "idleTime": 18,
    "longestIdlingInstance": 19,
    "input0Distance": 20,
    "input0Duration": 21,
    "input1Distance": 22,
    "input1Duration": 23,
    "input2Distance": 24,
    "input2Duration": 25,
    "input3Distance": 26,
    "input3Duration": 27,
    "maxSpeed": 28.1,
    "rpmEventsCount": 29,
    "rpmEventsLevel1Count": 30,
    "rpmEventsLevel2Count": 31,
    "rpmEventsLevel3Count": 32,
    "rpmEventsLevel4Count": 33,
    "rpmEventsLevel5Count": 34,
    "rpmEventsLevel6Count": 35,
    "rpmMax": 36,
    "speed20Count": 37,
    "speed30Count": 38,
    "speed40Count": 39,
    "speed50Count": 40,
    "speed60Count": 41,
    "speed70Count": 42,
    "speedEvents": 43,
    "journeyCount": 44
  }
]

application/xml, text/xml

Sample:

<ArrayOfSummerisedJourneyDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SummerisedJourneyDetails>
    <FirstJourneyStartDate>2025-11-04T14:29:34.1117984+00:00</FirstJourneyStartDate>
    <LastJourneyEndDate>2025-11-04T14:29:34.1117984+00:00</LastJourneyEndDate>
    <serviceId>3</serviceId>
    <accelMax>4.1</accelMax>
    <accelEventCount>5</accelEventCount>
    <accelHighEventCount>6</accelHighEventCount>
    <accelMediumEventCount>7</accelMediumEventCount>
    <accelLowEventCount>8</accelLowEventCount>
    <actionDistance>9</actionDistance>
    <actionDuration>10</actionDuration>
    <decelMax>11.1</decelMax>
    <decelEventCount>12</decelEventCount>
    <decelHighEventCount>13</decelHighEventCount>
    <decelMediumEventCount>14</decelMediumEventCount>
    <decelLowEventCount>15</decelLowEventCount>
    <distance>16.1</distance>
    <duration>17</duration>
    <idleTime>18</idleTime>
    <longestIdlingInstance>19</longestIdlingInstance>
    <input0Distance>20</input0Distance>
    <input0Duration>21</input0Duration>
    <input1Distance>22</input1Distance>
    <input1Duration>23</input1Duration>
    <input2Distance>24</input2Distance>
    <input2Duration>25</input2Duration>
    <input3Distance>26</input3Distance>
    <input3Duration>27</input3Duration>
    <maxSpeed>28.1</maxSpeed>
    <rpmEventsCount>29</rpmEventsCount>
    <rpmEventsLevel1Count>30</rpmEventsLevel1Count>
    <rpmEventsLevel2Count>31</rpmEventsLevel2Count>
    <rpmEventsLevel3Count>32</rpmEventsLevel3Count>
    <rpmEventsLevel4Count>33</rpmEventsLevel4Count>
    <rpmEventsLevel5Count>34</rpmEventsLevel5Count>
    <rpmEventsLevel6Count>35</rpmEventsLevel6Count>
    <rpmMax>36</rpmMax>
    <speed20Count>37</speed20Count>
    <speed30Count>38</speed30Count>
    <speed40Count>39</speed40Count>
    <speed50Count>40</speed50Count>
    <speed60Count>41</speed60Count>
    <speed70Count>42</speed70Count>
    <speedEvents>43</speedEvents>
    <journeyCount>44</journeyCount>
  </SummerisedJourneyDetails>
  <SummerisedJourneyDetails>
    <FirstJourneyStartDate>2025-11-04T14:29:34.1117984+00:00</FirstJourneyStartDate>
    <LastJourneyEndDate>2025-11-04T14:29:34.1117984+00:00</LastJourneyEndDate>
    <serviceId>3</serviceId>
    <accelMax>4.1</accelMax>
    <accelEventCount>5</accelEventCount>
    <accelHighEventCount>6</accelHighEventCount>
    <accelMediumEventCount>7</accelMediumEventCount>
    <accelLowEventCount>8</accelLowEventCount>
    <actionDistance>9</actionDistance>
    <actionDuration>10</actionDuration>
    <decelMax>11.1</decelMax>
    <decelEventCount>12</decelEventCount>
    <decelHighEventCount>13</decelHighEventCount>
    <decelMediumEventCount>14</decelMediumEventCount>
    <decelLowEventCount>15</decelLowEventCount>
    <distance>16.1</distance>
    <duration>17</duration>
    <idleTime>18</idleTime>
    <longestIdlingInstance>19</longestIdlingInstance>
    <input0Distance>20</input0Distance>
    <input0Duration>21</input0Duration>
    <input1Distance>22</input1Distance>
    <input1Duration>23</input1Duration>
    <input2Distance>24</input2Distance>
    <input2Duration>25</input2Duration>
    <input3Distance>26</input3Distance>
    <input3Duration>27</input3Duration>
    <maxSpeed>28.1</maxSpeed>
    <rpmEventsCount>29</rpmEventsCount>
    <rpmEventsLevel1Count>30</rpmEventsLevel1Count>
    <rpmEventsLevel2Count>31</rpmEventsLevel2Count>
    <rpmEventsLevel3Count>32</rpmEventsLevel3Count>
    <rpmEventsLevel4Count>33</rpmEventsLevel4Count>
    <rpmEventsLevel5Count>34</rpmEventsLevel5Count>
    <rpmEventsLevel6Count>35</rpmEventsLevel6Count>
    <rpmMax>36</rpmMax>
    <speed20Count>37</speed20Count>
    <speed30Count>38</speed30Count>
    <speed40Count>39</speed40Count>
    <speed50Count>40</speed50Count>
    <speed60Count>41</speed60Count>
    <speed70Count>42</speed70Count>
    <speedEvents>43</speedEvents>
    <journeyCount>44</journeyCount>
  </SummerisedJourneyDetails>
</ArrayOfSummerisedJourneyDetails>