Corridor/Segment Flow Analysis API
The Corridor/Segment Flow Analysis API introduces the getCorridorOriginDestinationMatrix API, which generates flow-based journey metrics between origins and destinations with optional connector zones for segment-based analysis.
Purpose
The getCorridorOriginDestinationMatrix API generates a list of origin, destination, and connector flows and the various journey metrics for flow-based journeys. The origin and destination provide endpoints on the flow but do not necessarily represent the start and end points of a vehicle traversal. Flow-based journeys are supported through passthrough attribution on both the origin and destination zones.
This API also allows for segment-based perspectives, with segment zones allowable on the origin, destination, and/or connector. At least one origin and one destination must be passed to the API.
Overview
This queryType has been migrated to dedicated REST endpoints. For full parameter and response schema documentation, see the following pages in the Altitude API Guide:
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v2/origin-destination/corridor-matrix | Start a corridor/segment flow OD matrix job. |
| GET | /api/v2/origin-destination/corridor-matrix/{id} | Retrieve corridor OD matrix results. |
| GET | /api/v2/origin-destination/corridor-matrix/{id}/time-series | Retrieve time-series results for a corridor OD matrix job. |
