get
/api/v2/origin-destination/open-matrix/{id}Python SDK method:
client.origin_destination.open_matrix(id=job_id).results()Get open OD matrix results
Returns paginated journey metric rows for a completed open-ended OD analysis job.
Altitude Help Center — Open-Ended OD APIInput 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 |
|---|---|---|
aggregationDateRanges | array<object> | Date ranges included in the aggregation. |
connectorCode | string | Raw connector zone code. |
connectorId | string | Encoded connector zone identifier for use in subsequent API requests. |
connectorType | string | Connector zone type. |
connector_iso_3166_2 | string | ISO 3166-2 state/province code of the connector zone. |
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. |
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). |
durationAtDestinationPercentiles | array<object> | Duration-at-destination percentiles (minutes). |
durationAtDestinationStdev | number | Duration at destination standard deviation (minutes). |
flowId | string | Flow identifier. |
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). |
jobId | string | Job identifier for this analysis result. |
journeyCount | integer | Observed journey count. |
journeyDistanceAvg | number | Average journey distance (miles or kilometers, according to isMetric). |
journeyDistanceMed | number | Median journey distance (miles or kilometers, according to isMetric). |
journeyDistancePercentiles | array<object> | Journey distance percentiles (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). |
journeyDurationPercentiles | array<object> | Journey duration percentiles (minutes). |
journeyDurationStdev | number | Journey duration standard deviation (minutes). |
journeyMetricsByFuelType | array<object> | Journey metrics by fuel type. |
journeyMetricsByIndustry | array<object> | Journey metrics by industry. |
journeyMetricsByVehicleClass | array<object> | Journey metrics by vehicle class. |
journeyMetricsByVehicleClassIndustry | array<object> | Journey metrics by vehicle class and industry. |
journeyMetricsByVehicleClassVocation | array<object> | Journey metrics by vehicle class and vocation. |
journeyMetricsByVocation | array<object> | Journey metrics by vocation. |
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. |
originType | string | Origin zone type. |
origin_iso_3166_2 | string | ISO 3166-2 state/province code of the origin zone. |
zoneFlowType | string | Open-ended flow type. |
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. |
