get
/api/v2/origin-destination/routes/{id}Python SDK method:
client.origin_destination.route(id=job_id).results()Get OD route analysis results
Returns paginated route rows for a completed OD route analysis job.
Altitude Help Center — getRouteAnalysisInput 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 |
|---|---|---|
asOfDate | string (date) | Reference date for the route row. |
dailyJourneyCountAvg | number | Average daily journey count. |
destinationCode | string | Raw destination zone code (e.g. county FIPS, ZIP code, custom zone ID). |
destinationId | string | Encoded destination zone identifier for use in subsequent API requests. |
destinationName | string | Destination zone description. |
destinationPassThrough | string | Destination pass-through flag or label. |
destinationType | string | Destination zone type. |
destination_iso_3166_2 | string | ISO 3166-2 state/province code of the destination zone. |
durationAtDestinationAvg | number | Average duration at destination (minutes). |
durationAtDestinationMed | number | Median duration at destination (minutes). |
durationAtDestinationStdev | number | Duration at destination standard deviation (minutes). |
geography | object | GeoJSON route geometry object. |
idleDurationAvg | number | Average idle duration (minutes). |
idleDurationMed | number | Median idle duration (minutes). |
idleDurationStdev | number | Idle duration standard deviation (minutes). |
interTripStopDurationAvg | number | Average inter-trip stop duration (minutes). |
interTripStopDurationMed | number | Median inter-trip stop duration (minutes). |
interTripStopDurationStdev | number | Inter-trip stop duration standard deviation (minutes). |
journeyCount | integer | Observed journey count. |
journeyCountByIndustry | array<object> | Journey count by industry. |
journeyCountByVehicleClass | array<object> | Journey count by vehicle class. |
journeyCountByVocation | array<object> | Journey count by vocation. |
journeyCountPctOfTotal | number | Journey count share of total. |
journeyCountTotal | integer | Total journey count. |
journeyDistanceAvg | number | Average journey distance (miles or kilometers, according to isMetric). |
journeyDistanceMed | number | Median journey distance (miles or kilometers, according to isMetric). |
journeyDistanceStdev | number | Journey distance standard deviation (miles or kilometers, according to isMetric). |
journeyDurationAvg | number | Average journey duration (minutes). |
journeyDurationMed | number | Median journey duration (minutes). |
journeyDurationStdev | number | Journey duration standard deviation (minutes). |
journeyTripCountAvg | number | Average trips per journey. |
journeyTripCountMed | number | Median trips per journey. |
journeyTripCountStdev | number | Trips per journey standard deviation. |
originCode | string | Raw origin zone code (e.g. county FIPS, ZIP code, custom zone ID). |
originId | string | Encoded origin zone identifier for use in subsequent API requests. |
originName | string | Origin zone description. |
originPassThrough | string | Origin pass-through flag or label. |
originType | string | Origin zone type. |
origin_iso_3166_2 | string | ISO 3166-2 state/province code of the origin zone. |
roadNameSequence | string | Road name sequence for the route. |
routeId | string | Route identifier. |
runningSpeedAvg | number | Average running speed (mph or km/h, according to isMetric). |
runningSpeedMed | number | Median running speed (mph or km/h, according to isMetric). |
runningSpeedStdev | number | Running speed standard deviation (mph or km/h, according to isMetric). |
segmentSequence | string | Segment sequence for the route. |
travelSpeedAvg | number | Average travel speed (mph or km/h, according to isMetric). |
travelSpeedMed | number | Median travel speed (mph or km/h, according to isMetric). |
travelSpeedStdev | number | Travel speed standard deviation (mph or km/h, according to isMetric). |
variants | array<object> | Route variants. |
zonePairId | string | Origin-destination zone pair identifier. |
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. |
