Get road reverse lookup results

Returns paginated road segment lookup rows for a completed road reverse lookup analysis job.

Altitude Help Center — getRoadReverseLookup

Input Parameters

Name	Location	Type	Values	Description	Value Required
`id`	path	string	-	Unique resource identifier.	Y
`pageToken`	query	string	-	Pagination token returned in the Link header of a previous response. Omit to fetch the first page.	N

Success Responses

200 response: object

Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.

Name	Type	Description
`aggregationPeriodFrom`	string	The time at the start of the aggregation period.
`cardinalDirection`	string	The cardinal direction of the road segment.
`direction`	integer (int64)	The direction of travel in relation to the segment definition: 1 indicates the direction of the segment; -1 indicates the opposite direction.
`dominantPace`	object	An object representing the dominant pace range.
`freeFlowSpeed`	number (double)	The free-flow speed for this segment (mph or km/h).
`observedCount`	integer (int64)	The aggregate number of observed vehicle passes for the road segment.
`observedCountByIndustry`	array<object>	Observed counts and vehicles by industry.
`observedCountByVehicleClass`	array<object>	Observed counts and vehicles by vehicle class.
`observedCountByVocation`	array<object>	Observed counts and vehicles by vocation.
`roadType`	string	OSM road classification.
`sampleSizePctByPace`	array<object>	Sample-size percentage for each pace band.
`segmentId`	string	The ID of the road segment.
`segmentLength`	number (double)	The length of the segment (miles or km) based on the value of isMetric.
`speedLimit`	integer (int64)	Posted speed limit for this segment (mph or km/h).
`spotSpeedAvg`	number (double)	The average Spot Speed (mph or km/h).
`spotSpeedHarmonic`	number (double)	Harmonic mean of Spot Speed.
`spotSpeedPctOfFreeFlow`	number (double)	Spot Speed as a percentage of free-flow speed.
`spotSpeedPctOfSpeedLimit`	number (double)	Spot Speed as a percentage of the speed limit.
`spotSpeedPctOverSpeedLimit`	number (double)	The percentage of vehicle passes where Spot Speed was over the speed limit.
`spotSpeedPercentiles`	array<object>	Percentile spot speed values.
`spotSpeedStdev`	number (double)	Standard deviation of Spot Speed.
`travelSpeedAvg`	number (double)	The average Travel Speed (mph or km/h).
`travelSpeedHarmonic`	number (double)	Harmonic mean of Travel Speed.
`travelSpeedPctOfFreeFlow`	number (double)	Travel Speed as a percentage of free-flow speed.
`travelSpeedPctOfSpeedLimit`	number (double)	Travel Speed as a percentage of the speed limit.
`travelSpeedPctOverSpeedLimit`	number (double)	The percentage of vehicle passes where Travel Speed was over the speed limit.
`travelSpeedPercentiles`	array<object>	Percentile travel speed values.
`travelSpeedStdev`	number (double)	Standard deviation of Travel Speed.
`travelTimeAvg`	number (double)	Average Travel Time (seconds).
`travelTimeDelayFromFreeFlow`	number (double)	Travel Time delay from free-flow (seconds).
`travelTimeFreeFlow`	number (double)	Free-flow Travel Time (seconds).
`travelTimeHarmonic`	number (double)	Harmonic mean of Travel Time.
`travelTimePercentiles`	array<object>	Percentile travel time values.
`travelTimeReliability`	number (double)	Travel Time reliability ratio.
`vehicleCount`	integer (int64)	The aggregate number of vehicles observed for the road segment.

Response Errors

HTTP Status Code	Reason
400	The request body or parameters are invalid.
401	Authentication is required or the provided credentials are invalid.
403	The authenticated user lacks permission to perform this operation.
404	The requested resource does not exist.
409	Result not yet ready. Poll the status monitor.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.