get
/api/v2/origin-destination/segments/{id}Python SDK method:
client.origin_destination.segment(id=job_id).results()Get OD segment analysis results
Returns paginated segment rows for a completed OD segment analysis job.
Altitude Help Center — getODSegmentAnalysisInput 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 segment row. |
dailyJourneyCountAvg | number (double) | Average daily journey count. |
geography | object | GeoJSON segment geometry object. |
journeyCount | integer (int64) | 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. |
roadType | string | OSM road classification. |
segmentId | string | Road segment identifier. |
segmentName | string | Road segment display name. |
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. |
