Corridor/Segment Flow Analysis API

The getCorridorOriginDestinationMatrix queryType generates a list of origin, destination, and connector flows and the various journey metrics for flow-based journeys.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.

ParameterDescriptionTypeDefined Value SetValue Required
queryTypeMust equal getCorridorOriginDestinationMatrix.STRINGgetCorridorOriginDestinationMatrixY
aggregationUnits

The requested time series aggregation units to be included in time series breakdowns. This attribute determines which time series breakdowns are generated if generateTimeSeries is set to true. Supported values (not case-sensitive) are:

  • hour — breakdown by hour from 0 to 23.
  • dayofweek — breakdown by day-of-week.
  • daytype — breakdown by day-of-week groupings, where "Weekend" = [1,7] and "Weekday" = [2,3,4,5,6].
  • daytypehour — breakdown by day type ("Weekend", "Weekday") and hour from 0 to 23.
ARRAY"hour", "dayofweek", "daytype", "daytypehour"N
customAggregationValues

Array of objects representing custom hourly range buckets for time series breakdowns. The custom aggregation values have the AggregationUnit "Custom" and each object creates an additional time series breakdown if generateTimeSeries is set to true. These breakdowns are in addition to any selected in aggregationUnits. Each object contains:

  • AggregationValue (string) — reference label for the custom aggregation bucket.
  • HourStart (integer) — first hour in the bucket hourly range.
  • HourEnd (integer) — last hour in the bucket hourly range.
Note:

An empty array will result in no additional time series breakdowns.

Note:

If both aggregationUnits and customAggregationValues are input, both resultant time series aggregations will be produced.

ARRAY-N
componentTimeRange

An object representing the analysis time range. Each object contains:

  • TimeFrom (string) — start of the time range formatted as "hh:mm:ss.ms" string.
  • TimeTo (string) — end of the time range formatted as "hh:mm:ss.ms" string. The default is "00:00:00" to "23:59:59.999".
  • Component (string) — one of "start" (journey must start in this time range), "end" (journey must end in this time range) or "both" (journey should start or end in this time range).
OBJECTComponent — ["start", "end", "both"]Y
connectorAndConditionTrue if the vehicle must pass through all connectors for a given journey, false if it must pass at least one connector. Default is false.BOOLEANTrue or falseN
dateRanges

An array of objects representing the date ranges of interest. Each object contains:

  • DateFrom (string) — first date in the analysis date range, formatted as "yyyy-mm-dd".
  • DateTo (string) — last date in the analysis date range, formatted as "yyyy-mm-dd".
Note: Analysis outputs will be aggregated and returned over all date ranges combined unless you input true for isTrendAnalysis, which returns results per date range.
Note: This API allows for a maximum of 1 year between the earliest DateFrom and the latest DateTo across all date ranges.
Note: A maximum of 4 date ranges may be provided. Date ranges may not overlap.
Note: For analyses using segments, the basemap AsOfDate utilized corresponds with the first of the month associated with the greatest DateTo across all date ranges.
ARRAY-Y
daysOfWeekAn array of integers representing each week day. Can send an empty array to return all days.ARRAY[1,7] (1 = Sunday, 2 = Monday, etc.)N
generateTimeSeries

An indicator of whether to generate a time series breakdown (true) or not (false) as a child analysis. Time series will be generated for each time aggregation in aggregationUnits.

Note: The time series breakdown results can be retrieved using the getSavedResults API. Pass the jobId value from this API call as the analysisJobId parameter and "getCorridorOriginDestinationMatrixTimeSeries" as the analysisType parameter value.
BOOLEANtrue or falseY
isMetricTrue if you want the data returned to be metric, false if you want imperial.BOOLEANTrue or falseY
isTrendAnalysis

Pass true if you want your results grouped based on the dateRanges parameter. For example, if you pass 4 date ranges and this is set to true, you will get 4 sets of results, one for each date range. The default is false.

Note: When set to true, this will be applied to both the main output and the time series output.
BOOLEANtrue or falseN
NAICSAn array of integers representing industry IDs. Can pass an empty array to return data for all industries. To get a list of available industries, use the getIndustries API.INTEGER-N
percentiles

Array of integers representing the percentiles for which you would like data. The default, if not provided, is [15,85].

Note: Percentiles are calculated for journey distance and journey duration.
Note: Altitude enforces a minimum sample size to support the requested number of percentiles. The minimum sample size is 2.5 times the number of percentiles requested. Should the sample for a flow fall short of this minimum sample, the percentiles will not be returned.
ARRAY[1, 5, 10, 15, 20, 30, 40, 50, 60, 70, 80, 85, 90, 95, 99]N
tripChainCriteria

An object that defines the trip chaining criteria to be applied for an analysis. Pass null if you wish to run without trip chaining. The object contains:

  • MaxStopDuration (integer) — amount of time (minutes) that a vehicle is allowed to stop and still be counted as part of the original journey. To view statistics related to stop durations, use the getStaticStopDurationData API.
  • ShortJourneyDistanceThreshold (float) — journey distance (kilometers or miles) used as the threshold distance for excluding short journeys. Any journey whose distance (after trip chaining is applied) is shorter than the threshold (inclusive) will be excluded from the analysis.

Default value is an empty object (no trip chaining).

Note: If you pass an empty object, no trip chaining will be applied.
OBJECTmaxStopDuration — [0, 15, 30, 60, 120, 480, 720]N
vehicleClasses

An array of vehicle class objects where each object contains VehicleType and WeightClass. To get the list of possible vehicle types and weight classes, refer to the Vehicle Types and Weight Class tables. If a vehicle type does not have any weight classes listed, pass "*". To get all vehicle classes returned, pass an empty array.

ARRAYFor Vehicle Type: "Truck", "Passenger", "MPV", "Bus", "Other". To get all vehicle types, pass an empty array.N
vehicleClassSchemeIdDetermines for which vehicle classification scheme you will receive data. See the Vehicle Class Schemas for a list of options. The default value is 2.INTEGER[1:5]N
vocationsAn array of integers representing vocation IDs for vocations of interest. Can pass specific IDs or an empty array to return data for all vocations.ARRAYSee Vocations for a list of vocation IDs and their mapping information.N
zoneConnectors

An array of objects representing connector zones that a flow-based journey should pass through (subject to the connectorAndCondition parameter) to be included in this analysis. Each object contains:

  • ZoneId (string) — A custom zone ID, standard zone ID (such as county ID, city ID, etc.) or segment.
  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones, segments or corridors and can be set to null.
  • ZoneType (string) — the type of zone.
ARRAY

ZoneType — "Segment", "Custom", "State", "County", "City", "TAZ", "ZIP", "CTR", or "FSA".

See Zones for details on how to structure the zone inputs for each zone type.

N
zoneDestinations

An array of objects representing the destination zones. Each object contains:

  • ZoneId (string) — A custom zone ID, standard zone ID (such as county ID, city ID, etc.) or a segment ID.
  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones or segments and can be set to null.
  • ZoneType (string) — the type of zone.
  • Passthrough (string) — a string with "true", "false", or "only" options. "only" will exclude journeys that stopped within the destination and only consider those which passed through it. "true" will include journeys that stopped or passed through the zone. "false" will include only journeys that stopped within the zone.
Note: Origins and destinations are cross joined to form the anchor points for flows. Any connectors included are overlaid onto each flow origin and destination.
Note: The origin and destination in a flow may not overlap. All flows that have the origin and destination overlapping will be flagged and excluded from the analysis.
ARRAY

ZoneType — "Segment", "Custom", "State", "County", "City", "TAZ", "ZIP", "CTR", or "FSA".

Passthrough — "true", "false" or "only".

See Zones for details on how to structure the zone inputs for each zone type.

Y
zoneOrigins

An array of objects representing the origin zones. Each object contains:

  • ZoneId (string) — A custom zone ID, standard zone ID (such as county ID, city ID, etc.) or a segment ID.
  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones or segments and can be set to null.
  • ZoneType (string) — the type of zone.
  • Passthrough (string) — a string with "true", "false", or "only" options. "only" will exclude journeys that started within the origin and only consider those which started outside the zone and passed through it. "true" will include journeys that started or passed through the zone. "false" will include only journeys that started within the zone.
Note: Origins and destinations are cross joined to form the anchor points for flows. Any connectors included are overlaid onto each flow origin and destination.
Note: The origin and destination in a flow may not overlap. All flows that have the origin and destination overlapping will be flagged and excluded from the analysis.
ARRAY

ZoneType — "Segment", "Custom", "State", "County", "City", "TAZ", "ZIP", "CTR", or "FSA".

Passthrough — "true", "false" or "only".

See Zones for details on how to structure the zone inputs for each zone type.

Y

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks, such as not providing credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact Altitude Support if this occurs.

Primary Response Schema

AttributeDescriptionData TypeDefined Value Set
AggregationDateRanges

Array of objects representing the date ranges utilized for the aggregated metrics. Each object contains:

  • DateFrom (string) — first date in the analysis date range formatted as "yyyy-mm-dd".
  • DateTo (string) — last date in the analysis date range formatted as "yyyy-mm-dd".
ARRAY-
ConnectorZones

Array of objects representing the connectors that an OD flow passed through. Sorted by ZoneId, ISO_3166_2, and ZoneType. Each object contains:

  • ZoneId (string) — A custom zone ID, standard zone ID (such as county ID, city ID, etc.) or segment ID.
  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones or segments and can be set to null.
  • ZoneType (string) — the type of zone.
ARRAY-
DailyJourneyCountAvgThe average daily number of journeys for the O/D flow.FLOAT-
DestinationZoneDescription

Description of the destination zone when available, based on the type of zone:

  • "State" — state name
  • "County" — county name
  • "City" — city name
  • "CTR" — census tract description
  • "Custom" — custom zone name
  • "Segment" — segment name, if available

For all other zones, this attribute is null.

STRING-
Destination_ISO_3166_2Unique ISO 3166-2 identifier representing the state/provincial code of the Destination.STRING-
DestinationPassthroughIndicates the passthrough value applied to the destination.STRING"true", "false" or "only"
DestinationZoneTypeZone type of the Destination.STRING-
DestinationZoneIdA unique identifier for the Destination zone.STRING-
FlowId

Unique identifier representing each flow. The FlowId for a flow pairing is a farm hash applied to the concatenated flow string that incorporates the origin, destination, and connector(s) identification details.

The following formatted string is hashed using a farm hash to form the FlowId for a flow:

<Origin.ZoneId>_<Origin.ZoneType>_<Origin.ISO_3166_2>_<Origin.Passthrough>_<Destination.ZoneId>_<Destination.ZoneType>_<Destination.ISO_3166_2>_<Destination.Passthrough>_[<Connector.ZoneId>_<Connector.ISO_3166_2>_<Connector.ZoneType>]

Note: If there are multiple connectors in the flow, all of them will be included, ordered by ZoneId, ISO_3166_2, and ZoneType.

FlowIds are used for follow-on API requests like getRouteAnalysis.

INT64-
InterTripStopDurationAvg

The average of the total stop duration that occurs during the OD flow. The stop duration during an OD flow is calculated as the sum of all stop durations between trips that comprise the OD flow.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 0.
FLOAT-
InterTripStopDurationMed

The median of the total stop duration that occurs during an OD flow. The stop duration during an OD flow is calculated as the sum of all stop durations between trips that comprise the OD flow.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 0.
FLOAT-
InterTripStopDurationStdev

The standard deviation of the total stop duration that occurs during an OD flow. The stop duration during an OD flow is calculated as the sum of all stop durations between trips that comprise an OD flow.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 0.
FLOAT-
AnalysisJobIdJobId for the O/D flow. The job analysis jobId is required for follow-on API requests, for example getRouteAnalysis.STRING-
JourneyCountThe total number of journeys for the O/D flow.INTEGER-
JourneyMetricsByFuelType

Array of objects representing journey count metrics for each fuel type. Each object contains:

  • FuelType (string) — fuel type.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for an O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyMetricsByIndustry

Array of objects representing journey count metrics for each NAICS code 1. Each object contains:

  • NAICS_Code_1 (integer) — NAICS code 1.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for an O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyMetricsByVehicleClass

Array of objects representing journey count metrics for each vehicle class. Each object contains:

  • SchemeId (integer) — vehicle class scheme identifier.
  • CategoryIndex (integer) — vehicle class category identifier.
  • VehicleClassIndex (integer) — vehicle class identifier.
  • VehicleClass (string) — vehicle class name.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for an O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyMetricsByVehicleClassVocation

Array of objects representing journey count metrics for each vehicle class/vocation combination. Each object contains:

  • SchemeId (integer) — vehicle class scheme identifier.
  • CategoryIndex (integer) — vehicle class category identifier.
  • VehicleClassIndex (integer) — vehicle class identifier.
  • VehicleClass (string) — vehicle class name.
  • VocationId (integer) — unique identifier for the vocation.
  • Vocation (string) — vocation name.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for an O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyMetricsByVehicleClassIndustry

Array of objects representing journey count metrics for each vehicle class/industry combination. Each object contains:

  • SchemeId (integer) — vehicle class scheme identifier.
  • CategoryIndex (integer) — vehicle class category identifier.
  • VehicleClassIndex (integer) — vehicle class identifier.
  • VehicleClass (string) — vehicle class name.
  • NAICS_Code_1 (integer) — NAICS code 1.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for the O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyMetricsByVocation

Array of objects representing journey counts for each vocation. Each object contains:

  • VocationId (integer) — unique identifier for the vocation.
  • Vocation (string) — vocation name.
  • JourneyCount (integer) — number of journeys.
  • JourneyDistanceAvg (float) — average distance traveled for an O/D flow (kilometers or miles).
  • JourneyDistanceMed (float) — median distance traveled for an O/D flow (kilometers or miles).
  • JourneyDurationAvg (float) — average journey duration for an O/D flow (minutes).
  • JourneyDurationMed (float) — median journey duration for an O/D flow (minutes).
  • InterTripStopDurationAvg (float) — average of the total stop duration that occurs during the OD flow (minutes).
  • InterTripStopDurationMed (float) — median of the total stop duration that occurs during the OD flow (minutes).
ARRAY-
JourneyDistanceAvgThe average distance traveled for the flow-based journey portion (first entry to Origin; last exit from Destination) for an O/D flow (kilometers or miles).FLOAT-
JourneyDistanceMedThe median distance traveled for the flow-based journey portion (first entry to Origin; last exit from Destination) for an O/D flow (kilometers or miles).FLOAT-
JourneyDistancePercentile

Array of objects representing percentile flow-based journey (first entry to Origin; last exit from Destination) distance values for input percentiles. Each object contains:

  • Percentile (integer) — the percentile value.
  • Value (float) — the calculated percentile journey distance for the flow-based journey portion value (kilometers or miles).
Note: If no percentiles are input, the 15th and 85th percentiles are provided by default.
Note: Percentiles will only be provided if there are sufficient samples to calculate the requested number of percentiles. The minimum sample size is 2.5 times the number of percentiles requested.
ARRAY-
JourneyDistanceStdevThe standard deviation of the distance traveled for the flow-based journey portion (first entry to Origin; last exit from Destination) for an O/D flow (kilometers or miles).FLOAT-
JourneyDurationAvgThe average journey duration (minutes) for the flow-based journey portion (first entry to Origin; last exit from Destination) for an O/D flow (in minutes).FLOAT-
JourneyDurationMedThe median journey duration (minutes) for the flow-based journey portion (first entry to Origin; last exit from Destination) for the O/D flow (in minutes).FLOAT-
JourneyDurationPercentiles

Array of objects representing percentile journey duration values for input percentiles. Each object contains:

  • Percentile (integer) — the percentile value.
  • Value (float) — the calculated percentile journey duration for the flow-based journey portion value (minutes).
Note: If no percentiles are input, the 15th and 85th percentiles are provided by default.
Note: Percentiles will only be provided if there are sufficient samples to calculate the requested number of percentiles. The minimum sample size is 2.5 times the number of percentiles requested.
ARRAY-
JourneyDurationStdevThe standard deviation of the journey duration (minutes) for an O/D flow (in minutes).FLOAT-
JourneyTripCountAvg

The average number of trips per journey.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 1.
FLOAT-
JourneyTripCountMed

The median number of trips per journey.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 1.
FLOAT-
JourneyTripCountStdevThe standard deviation of the number of trips per journey.FLOAT-
OriginZoneDescription

Description of the origin zone when available, based on the type of zone:

  • "State" — state name
  • "County" — county name
  • "City" — city name
  • "CTR" — census tract description
  • "Custom" — custom zone name
  • "Segment" — segment name, if available

For all other zones, this attribute is null.

STRING-
Origin_ISO_3166_2Unique ISO 3166-2 identifier representing the state/provincial code of the Origin.STRING-
OriginPassthroughIndicates the passthrough value applied to the origin.STRING"true", "false" or "only"
OriginZoneTypeZone type of the Origin.STRING-
OriginZoneIdA unique identifier for the Origin zone.STRING-

Sample Parameters

Sample parameters that should go inside your functionParameters object:

{
    "aggregationUnits": [],
    "componentTimeRange": {
        "TimeFrom": "00:00:00",
        "TimeTo": "23:59:59",
        "Component": "Start"
    },
    "dateRanges": [
        {
            "DateFrom": "<YYYY-MM-DD>",
            "DateTo": "<YYYY-MM-DD>"
        }
    ],
    "daysOfWeek": [],
    "generateTimeSeries": true,
    "isMetric": true,
    "NAICS": [],
    "percentiles": [5, 15, 85, 95],
    "queryType": "getCorridorOriginDestinationMatrix",
    "tripChainCriteria": {
        "MaxStopDuration": 30,
        "ShortJourneyDistanceThreshold": 2
    },
    "vehicleClasses": [],
    "vehicleClassSchemeId": 2,
    "vocations": [],
    "zoneOrigins": [
        {
            "ZoneId": "<ZoneId>",
            "ISO_3166_2": "<ISO_3166_2>",
            "ZoneType": "<ZoneType>",
            "Passthrough": "false"
        }
    ],
    "zoneConnectors": [
        {
            "ZoneId": "<ZoneId>",
            "ISO_3166_2": "<ISO_3166_2>",
            "ZoneType": "<ZoneType>"
        }
    ],
    "zoneDestinations": [
        {
            "ZoneId": "<ZoneId>",
            "ISO_3166_2": "<ISO_3166_2>",
            "ZoneType": "<ZoneType>",
            "Passthrough": "false"
        }
    ]
}

Time Series Response Schema

This breakdown result is only created if generateTimeSeries is set to true.

The time series breakdown results can be retrieved using the getSavedResults API. Pass the jobId value from the original API call as the analysisJobId parameter and "getCorridorOriginDestinationMatrixTimeSeries" as the analysisType parameter value.

A journey is accounted in and contributes to metrics for each aggregation unit and associated value that overlaps the journey. For example, a journey that starts at "2025-03-01 01:00:00" and ends at "2025-03-01 10:00:00" will be accounted for and contribute to metrics for the hours 1 through 10.

AttributeDescriptionData TypeDefined Value Set
AggregationDateRanges

Array of objects representing the date ranges utilized for the aggregated metrics. Each object contains:

  • DateFrom (string) — first date in the analysis date range formatted as "yyyy-mm-dd".
  • DateTo (string) — last date in the analysis date range formatted as "yyyy-mm-dd".
ARRAY-
AggregationUnitThe time-based unit by which to aggregate data.STRING"hour", "dayofweek", "daytype", "daytypehour"
AggregationValue

The associated AggregationUnit value. The value set is based on the AggregationUnit value. Value format based on AggregationUnit:

  • hour — number of the hour based on 24-hour format, for example 1 or 16.
  • dayofweek — numeric value for day of week where Sunday is 1 and Saturday is 7.
  • daytype — string for the day type ["Weekend", "Weekday"].
  • daytypehour — string for day type and hour consolidated, for example "Weekday_22".
STRING-
ConnectorZones

Array of objects representing the connectors that an OD flow passed through. Sorted by ZoneId, ISO_3166_2, ZoneType. Each object contains:

  • ZoneId (string) — A custom zone ID, standard zone ID (such as county ID, city ID, etc.) or segment ID.
  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones or segments and can be set to null.
  • ZoneType (string) — the type of zone.
ARRAY-
DestinationZoneDescription

Description of the destination zone when available, based on the type of zone:

  • "State" — state name
  • "County" — county name
  • "City" — city name
  • "CTR" — census tract description
  • "Custom" — custom zone name
  • "Segment" — segment name, if available

For all other zones, this attribute is null.

STRING-
Destination_ISO_3166_2Unique ISO 3166-2 identifier representing the state/provincial code of the Destination.STRING-
DestinationZoneTypeZone type of the Destination.STRING-
DestinationZoneIdA unique identifier for the Destination zone.STRING-
FlowId

Unique identifier representing each flow. The FlowId for a flow pairing is a farm hash applied to the concatenated flow string that incorporates the origin, destination, and connector(s) identification details.

The following formatted string is hashed using a farm hash to form the FlowId for a flow:

<Origin.ZoneId>_<Origin.ZoneType>_<Origin.ISO_3166_2>_<Origin.Passthrough>_<Destination.ZoneId>_<Destination.ZoneType>_<Destination.ISO_3166_2>_<Destination.Passthrough>_[<Connector.ZoneId>_<Connector.ISO_3166_2>_<Connector.ZoneType>]

Note: If there are multiple connectors in the flow, all of them will be included, ordered by ZoneId, ISO_3166_2, and ZoneType.

FlowIds are used for follow-on API requests like getRouteAnalysis.

INT64-
InterTripStopDurationAvg

The average of the total stop duration that occurs during an OD flow. The stop duration during an OD flow is calculated as the sum of all stop durations between trips that comprise the OD flow.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 0.
FLOAT-
InterTripStopDurationMed

The median of the total stop duration that occurs during an OD flow. The stop duration during an OD flow is calculated as the sum of all stop durations between trips that comprise an OD flow.

Note: If no trip chaining is applied (i.e., tripChainCriteria.maxStopDuration is 0), this value will also be 0.
FLOAT-
JourneyCountThe total number of journeys between the O/D pair.INTEGER-
JourneyCountByVehicleClass

Array of objects representing journey count metrics for each vehicle class. Each object contains:

  • SchemeId (integer) — vehicle class scheme identifier.
  • CategoryIndex (integer) — vehicle class category identifier.
  • VehicleClassIndex (integer) — vehicle class identifier.
  • VehicleClass (string) — vehicle class name.
  • JourneyCount (integer) — number of journeys.
ARRAY-
JourneyCountByVocation

Array of objects representing journey counts for each vocation. Each object contains:

  • VocationId (integer) — unique identifier for the vocation.
  • Vocation (string) — vocation name.
  • JourneyCount (integer) — number of journeys.
ARRAY-
JourneyDistanceAvgThe average distance traveled for the flow-based journey portion (first entry to Origin; last exit from Destination) between an O/D flow pair (kilometers or miles).FLOAT-
JourneyDistanceMedThe median distance traveled for the flow-based journey portion (first entry to Origin; last exit from Destination) between an O/D flow pair (kilometers or miles).FLOAT-
JourneyDurationAvgThe average journey duration (minutes) for the flow-based journey portion (first entry to Origin; last exit from Destination) between the O/D flow pair (in minutes).FLOAT-
JourneyDurationMedThe median journey duration (minutes) for the flow-based journey portion (first entry to Origin; last exit from Destination) between the O/D flow pair (in minutes).FLOAT-
OriginZoneDescription

Description of the origin zone when available, based on the type of zone:

  • "State" — state name
  • "County" — county name
  • "City" — city name
  • "CTR" — census tract description
  • "Custom" — custom zone name
  • "Segment" — segment name, if available

For all other zones, this attribute is null.

STRING-
Origin_ISO_3166_2Unique ISO 3166-2 identifier representing the state/provincial code of the Origin.STRING-
OriginZoneTypeZone type of the Origin.STRING-
OriginZoneIdA unique identifier for the Origin zone.STRING-
Previous
Next