get
/api/v2/traffic/speed-map-metrics/{id}Python SDK method:
client.traffic.speed_map_metrics(id=job_id).results()Get speed map metrics results
Returns paginated speed map metric rows per road segment for a completed speed map metrics analysis job.
Altitude Help Center — getSpeedMapMetricsInput 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 |
|---|---|---|
observedCount | integer (int64) | The aggregate number of observed vehicle passes for the road segment, given the applied filters. |
roadType | string | OSM road classification. |
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). |
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. |
travelSpeedAvg | number (double) | The average Travel Speed (mph or km/h). |
travelTimeAvg | number (double) | Average Travel Time (seconds). |
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. |
