Open-Ended OD API
The getOpenEndedOriginDestinationMatrix API generates journey metrics anchored on a single zone, returning traffic patterns across four Zone Flow Types.
The Open-Ended OD API introduces zone-centric analysis anchored on a single zone. Users anchor their analysis on a zone and the system discovers all traffic patterns, returning all four Zone Flow Types by default. Pass the getOpenEndedOriginDestinationMatrix endpoint generates a list of origins, destinations, and connectors (anchor zone for E:E zone flow type), along with various journey metrics for zone flow-based journeys. At least one anchor zone must be passed to the API.
Zone Flow Types
A zone flow type represents a distinct traffic pattern in relation to an anchor zone (zone of interest):
- Internal-Internal (I:I): traversal that starts and ends in the anchor zone
- Internal-External (I:E): traversal that starts in the anchor zone and ends in a destination zone (excluding the anchor zone)
- External-Internal (E:I): traversal that starts in an origin zone (excluding anchor zone) and ends in the anchor zone
- External-External (E:E): traversal that starts in an origin zone (excluding anchor zone), passes through the anchor zone (represented as connector), and ends in a destination zone (excluding anchor zone)
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/open-matrix | Start an open-ended OD matrix job. |
| GET | /api/v2/origin-destination/open-matrix/{id} | Retrieve open-ended OD matrix results. |
| GET | /api/v2/origin-destination/open-matrix/{id}/time-series | Retrieve time-series results for an open-ended OD matrix job. |
