get
/api/v2/traffic/speed-summary/{id}Python SDK method:
client.traffic.speed_summary(id=job_id).results()Get speed summary results
Returns paginated aggregated speed metric rows for a completed speed summary analysis job.
Altitude Help Center — getSpeedAnalysisSummaryInput 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 | The direction of the road segment in terms of 'N', 'NE', 'E', etc. Only populated when isDirectional is true. For custom zones this represents the cardinal direction with the most relative road coverage. |
corridorDirection | integer (int64) | For corridor analyses with isDirectional true: 1 refers to traffic traversing in the order of segments provided; -1 refers to traffic in the inverse order. |
corridorLength | number (double) | The total length of the selected road segments (miles or km). Only populated for corridor analyses with segment inputs. |
dominantPace | object | An object representing the 10 mph or 10 km/h range with the highest share of traffic. |
freeFlowSpeedAvg | number (double) | The average free flow speed for the given set of filters across the road segments (mph or km/h). |
observedCount | integer (int64) | The aggregate number of observed vehicle passes for the road segment, given the applied filters. Only returned for a single segment query. |
observedCountByIndustry | array<object> | Array of objects representing the observed count of traversals and vehicles for each NAICS code 1. |
observedCountByVehicleClass | array<object> | Array of objects representing the observed count of traversals and vehicles for each vehicle class. |
observedCountByVocation | array<object> | Array of objects representing the observed count of traversals and vehicles for each vocation. |
sampleSizePctByPace | array<object> | Array of objects representing the size percentage for each pace band. |
segmentsDirectional | array<object> | Array of objects representing directional segments in the order of the corridor as input. Populated if a corridor of segments was provided. |
speedLimitAvg | integer (int64) | The average speed limit, weighted by traffic volume across all roads selected (km/h or mph). |
speedLimitMax | integer (int64) | The highest speed limit across selected roads (km/h or mph). |
speedLimitMin | integer (int64) | The lowest speed limit across selected roads (km/h or mph). |
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 selected roads (mph or km/h). |
spotSpeedPctOfFreeFlow | number (double) | Spot Speed as a percentage of free-flow speed. |
spotSpeedPctOfSpeedLimit | number (double) | The average Spot Speed as a percentage of the weighted average speed limit. |
spotSpeedPctOverSpeedLimit | number (double) | The percentage of vehicle passes where the Spot Speed was over the speed limit. |
spotSpeedPercentiles | array<object> | Array of objects representing percentile spot speed values for input percentiles. If no percentiles are input, the 15th, 50th and 85th percentiles are provided by default. |
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 the average speed (km/h or mph) calculated by dividing the total length of the selected roads by the travel time. |
travelSpeedPctOfFreeFlow | number (double) | Travel Speed as a percentage of free-flow speed. |
travelSpeedPctOfSpeedLimit | number (double) | The average Travel Speed as a percentage of the weighted average speed limit. |
travelSpeedPctOverSpeedLimit | number (double) | The percentage of vehicle passes where the Travel Speed was over the speed limit. |
travelSpeedPercentiles | array<object> | Array of objects representing percentile travel speed values for input percentiles. If no percentiles are input, the 15th, 50th and 85th percentiles are provided by default. |
travelSpeedStdev | number (double) | Standard deviation of Travel Speed. |
travelTimeAvg | number (double) | Average Travel Time (seconds). |
travelTimeDelayFromFreeFlow | number (double) | 50th percentile Travel Time minus Free-flow Travel Time (seconds). |
travelTimeFreeFlow | number (double) | Free-flow Travel Time (seconds). |
travelTimeHarmonic | number (double) | Harmonic mean of the time taken to travel along the selected roads (Travel Time in seconds). |
travelTimePercentiles | array<object> | Array of objects representing percentile travel time values for input percentiles. If no percentiles are input, the 15th, 50th and 85th percentiles are provided by default. |
travelTimeReliability | number (double) | Ratio of the 85th percentile Travel Time to the median (50th percentile) Travel Time. |
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. |
