get
/api/v2/traffic/speed-per-segment/{id}Python SDK method:
client.traffic.speed_per_segment(id=job_id).results()Get speed per segment results
Returns paginated speed metric rows for each input road segment from a completed speed per segment analysis job.
Altitude Help Center — getSpeedAnalysisPerSegmentInput 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. For a summary analysis the value will be 'Summary'. |
cardinalDirection | string | Cardinal direction of travel. |
direction | integer (int64) | Direction of travel: 1 follows the segment definition and -1 is opposite. |
dominantPace | object | An object representing the dominant pace range. |
freeFlowSpeed | number (double) | Free-flow speed in miles per hour or kilometres per hour according to isMetric. |
observedCount | integer (int64) | The aggregate number of observed vehicle passes for the road segment, given the applied filters. |
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 | Road segment identifier. |
segmentLength | number (double) | Road segment length in miles or kilometres according to isMetric. |
speedLimit | integer (int64) | Posted speed limit in miles per hour or kilometres per hour according to isMetric. |
spotSpeedAvg | number (double) | The average Spot Speed (mph or km/h). |
spotSpeedHarmonic | number (double) | Harmonic mean of the maximum individual speed observed as a vehicle drives through the segment. |
spotSpeedPctOfFreeFlow | number (double) | Spot Speed as a percentage of free-flow speed. |
spotSpeedPctOfSpeedLimit | number (double) | The average 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 along the segment. |
travelSpeedPctOfFreeFlow | number (double) | Travel Speed as a percentage of free-flow speed. |
travelSpeedPctOfSpeedLimit | number (double) | The average 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 along the segment. |
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, given the applied filters. |
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. |
