Closed OD API

The getZoneClosedOriginDestinationMatrix API generates journey metrics for a defined set of origin and destination pairs, supporting all four traffic flow scenarios relative to an analysis geography.

Purpose

Closed or defined OD tackles OD as a defined set of OD pairs for which we are looking to understand metrics on aggregated flow.

The getZoneClosedOriginDestinationMatrix endpoint generates a list of origin and destination pairs that contain various journey metrics for the origin and destination combo. At least one origin and one destination must be passed to the API, and you can mix origin and destination types (for example, a custom zone origin with a standard zone destination).

How to Achieve Traffic Analysis Scenarios

Traffic flow is typically classified into four scenarios in relation to an analysis geography: internal-to-internal, internal-to-external, external-to-internal, and external-to-external (passthrough).

  • Internal-to-Internal
    • Origin: Zone of interest (zoneOrigins = Chicago)
    • Destination: Zone of interest (zoneDestinations = Chicago)
    • Trip Chain Duration: 0+
    • TimeRange.Component: start
  • Internal-to-External
    • Origin: Zone of interest (zoneOrigins = Chicago)
    • Destination: All zones within analysis distance of zone of interest
    • Trip Chain Duration: 0+
    • TimeRange.Component: start
  • External-to-Internal
    • Origin: All zones within analysis distance of zone of interest
    • Destination: Zone of interest (zoneDestinations = Chicago)
    • Trip Chain Duration: 0+
    • TimeRange.Component: end
  • External-to-External
    • Origin: All zones within analysis distance of zone of interest
    • Destination: All zones within analysis distance of zone of interest
    • Trip Chain Duration: 0+
    • Connector: Zone of interest
    • Connector And Condition: true
    • TimeRange.Component: both

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/closed-matrix Start a closed OD matrix job.
GET /api/v2/origin-destination/closed-matrix/{id} Retrieve closed OD matrix results.
GET /api/v2/origin-destination/closed-matrix/{id}/time-series Retrieve time-series results for a closed OD matrix job.
Previous
Next