API Updates - September 2025
We've added new fields to the AggregateByPath response, allowing users to extract more detailed information.
AggregateByPath
The AggregateByPath
endpoint provides aggregate-level information about speeds, near-misses, travel time, g-forces, and volume. It’s the backend to our Path Analysis tool on the Road Intelligence platform.
We’ve updated this endpoint to include extra response fields, reflecting new features on the Road Intelligence platform. In the AggregateByPath
response, there is total
, hourOfDay
, dayOfWeek
, distanceAlongPath
, and vehicleType
information. Within each of these, you will now find the additional fields:
- Queue Length -
queueLengthHistogram
andqueueLength
. - G-force Distribution -
absoluteYaccDistribution
,negativeXaccDistribution
,positiveXaccDistribution
, andgforceDistribution
.
Queue Length Field
Queue length helps to understand how a linestring is performing, and if a queue is forming. Queueing is identified when a packet in a linestring has a speed less than or equal to 5km/h. From this point, the queue is measured (in metres) up to the end of the linestring.
What’s the difference between queueLength and queueLengthHistogram?
queueLength
gives aggregate information of the queueing. So the average, median, 85th and 15th percentile, and it’s standard deviation.queueLengthHistogram
can be used to create histograms/charts that aggregate queueing byvehicleType
,hourOfDay
anddayOfWeek
.
What do I need to do to receive this queue length information?
You don’t need to complete anything extra in your AggregateByPath
request. Queue Length is automatically calculated.
What does each part of queueLengthHistogram mean?
The queueLengthHistogram
can be used to create a histogram where:
stepSize
is the increment or range. For example, if I put 10, this means my queue length chart will be in 10 metre increments.start
is the lowest value (in metres) you want the queue length graph to begin.count
is the volume of vehicles recorded in the queue length. Note, that this is not a reflection of the total volume query - it is a subset. Only connected vehicles with a high enough packet frequency are included in queue length outputs.
G-force Distribution Fields
G-force distribution shows the percentage of vehicles across different ranges for a selected linestring. The g-force distribution fields give the information you need to build a table, showing the percentage of vehicles that fit into each respective range or ‘bin’.
What do all the different g-force distribution fields mean?
gforceDistribution
is the overall intensity and summary of braking, accelerating, and steering movements.absoluteYaccDistribution
is how a car moves from side to side (i.e. steering). A negative value is left steering, while a positive value is right steering.negativeXaccDistribution
is when a vehicle brakes.positiveXaccDistribution
is when a vehicle accelerates.
What do I need to do to receive this information?
Before getting to the interpret the g-force distribution fields in your response, you’ll need to complete the accDistribution
. This is similar to the speedDistribution
field, where:
stepSize
is the increment or range. For example, if I put 0.1, this means distributions will be in 0.1 g-force increments. So, 0.1G, 0.2G, 0.3G and so on.rangeStart
is the lowest value you want the g-force distribution information to begin.rangeEnd
is the highest value you want the g-force distribution information to end.
What does each part in the response mean?
Each g-force distribution field is set out similarly to the speedDistribution
field in the AggregateByPath
response.
tripCountAggregatePercentile
is the percentage of trips in a specific bin versus trips in the current aggregate.tripCountTotalPercentile
is the percentage of trips in a specific bin versus trips across the whole linestring.rangeEnd
is the highest value (in g-forces) you want the distribution to end.rangeStart
is the lowest value (in g-forces) you want the distribution to begin.
We've added a new vehicle type across all endpoints called CONSTRUCTION_VEHICLE.
Please update any SDKs to reflect this change.