queryType: getRoadReverseLookup*

An object defining the aggregation requirements for the analysis. Each object contains:

• Value (integer) - the time interval and can be any integer.

• Unit (string) - unit for the interval and can be any of “minute”, “hour” or “week”.

• For example, if you want the breakdown of road segments by hour that matches your criteria, you would enter 1 for Value and “hour” for Unit. If you just want a summary of the entire time period, pass any number for Value and “*” for Unit.

An object defining the analysis date range. 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".

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”.

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 Vehicle types and Weight class tables. If a vehicle type does not have any weight classes listed, just pass "*". More information on vehicle classes can be found at AFDC Vehicle Categories. To get all vehicle classes returned, pass an empty array.

See the Vehicle types and Weight class tables.

For Vehicle Type: "Truck", "Passenger", "MPV", "Bus", "Other". More information at AFDC Vehicle Categories.

To get all vehicle types, pass an empty array.

An array of objects representing the zones for which you want information. Each object contains ZoneId, ISO_3166_2, and ZoneType:

• ZoneId (string) – A custom zone ID, a segment ID, or a standard zone ID such as county ID, city ID, etc.

• ISO_3166_2 (string) – The ISO code of the standard zone. Does not apply to custom zones, segments or related roads and can be set to null.

• ZoneType (string) – the type of zone.

• ZoneType - “Custom”

• “Segment”

• “State”

• “County”

• “City”

• “TAZ”

• “ZIP”

• “CTR”

• “FSA”

At least one filter must be provided from the filter parameters listed below.

An object containing FilterValue and FilterMode. If you want all segments that have a speed limit greater than 60mph, for example, you would pass “speedLimit”:{“FilterValue”: 60, “FilterMode”: “greater”}.

FilterValue - any valid float number.

FilterMode - “greater”, “less”.

Same as speedLimit above, but refers to spot speed. Also has an added FilterType property that allows you to specify “average” or “median” for your comparison. For example, you would pass "spotSpeed": {"FilterType": "average", "FilterValue": 0,"FilterMode":"greater"}.

FilterValue - any valid float number.

FilterMode - “greater”, “less”.

FilterType - “average”, “Median”.

An object representing the 10 mph or 10km/h range with the highest share of traffic. The object contains:

• PaceFrom (float) - lower bound of bucket.

• PaceTo (float) - upper bound of bucket.

Array of objects representing the observed count of traversals and vehicles of each industry. Each object contains:

• NAICS_Code_1 (integer) - NAICS code 1.

• ObservedCount (integer) - number of traversals.

• VehicleCount (integer) - number of vehicles.

Array of objects representing the observed count of traversals and vehicles of 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.

• ObservedCount (integer) - number of traversals.

• VehicleCount (integer) - number of vehicles.

Array of objects representing the observed count of traversals and vehicles of each vocation. Each object contains:

• VocationId (integer) - unique identifier for the vocation.

• Vocation (string) - vocation name.

• ObservedCount (integer) - number of traversals.

• VehicleCount (integer) - number of vehicles.

Array of objects representing the size percentage for each pace band. Each object contains:

• PaceFrom (float) - the lower bound of the pace band.

• PaceTo (float) - the upper bound of the pace band.

• SampleSizePct (float) - percentage of the samples that fall into this pace band.

Array of objects representing percentile spot speed values for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile spot speed value (mph or km/h).

Array of objects representing percentile travel speed values for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile travel speed value (mph or km/h).

Array of objects representing percentile travel time values for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile travel time value (seconds).