queryType: getStopAnalytics*

Geographic aggregation mode.

0: By road segment

1: By related roads

2: By zone

3: By H3

4. By geohash

5. By S2

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

Whether to return hierarchy of hashes (true) or each level separately (false). Default value is false.

Example: we have selected H# aggregation (mode 3) and chosen cell levels 5 (minCellLevel) through 7 (maxCellLevel).

If we input false: we will get a result record for each contained H3 cell at level 5 through 7 that has valid results.

If we input true: favors returning the highest level of granularity with the least amount of redundancy while still maintaining coverage of all stops i.e., we will only get a result record for contained H3 cells at level 5 through 7, for which all of their possible (where we have coverage) children cells cannot be returned. So if all of a particular level 6 H3 cells’ children have sufficient coverage, we will return those level 7 children and exclude the overarching level 6 H3 cell. If some of those level 7 children cannot be returned, we will return the level 6 H3 and all of its available children.

Whether to include geography in the output (true) or not (false).

Absolute Maxs:

• 15 for H3

• 12 for Geohash

• 30 for S2

Minimum cell level for H3, geohash, or S2 aggregation modes.

Default value is 5 for H3, 5 for Geohash, and 10 for S2.

Absolute Mins:

• 0 for H3

• 1 for Geohash

• 0 for S2

An array of strings representing related road types for which we want data.

Array of strings representing the different road types for which you want data. Empty array means all road types.

Array of integers representing the upper bounds (inclusive) of stop durations (minutes) bins on which to report aggregation metrics.

The lower bound for a bin is the previous stop duration in the array (non-inclusive).

If the user specifies a maxStopDuration parameter value, this will be used as the upper bound for the final bucket, otherwise it goes to +inf. If the user specifies a minStopDuration parameter value, this will be used as the lower bound for the first bucket, otherwise it starts at 0.

For example, the array [10, 30, 60] with no values for the parameter minStopDuration and maxStopDuration would create the following bins: (0, 10], (10, 30], (30, 60], (60, +inf)

An object representing the time range and whether trips should start in the time range, end in the time range, or both.

• TimeFrom - a string representing the start time in "hh:mm:ss" format.

• TimeTo - a string representing the end time in "hh:mm:ss" format.

(Default 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 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 and can be set to null.

• ZoneType (string)– the type of zone.

• ZoneType - “Custom”

• “State”

• “County”

• “City”

• “TAZ”

• “ZIP”

• “CTR”

• “FSA”.

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

A GeoJSON string representing the geography of the zone.

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

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile idle duration value (minutes).

Whether the road segment is one-way (true) or not (false).

Array of objects representing percentile trip distance values for the trip after the stop, for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile trip distance (miles or kilometers) for the trip after the stop.

Array of objects representing percentile trip duration values for the trip after the stop, for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile trip duration (minutes) for the trip after the stop.

Array of objects representing percentile trip distance values for the trip leading up to the stop, for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile trip distance (miles or kilometers) for the trip leading to the stop.

Array of objects representing percentile trip duration values for the trip leading up to the stop, for input percentiles. Each object contains:

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile trip duration (minutes) for the trip leading to the stop.

Array of objects representing count metrics for stop duration bins. Each object contains:

• Bin (string) — a string representation of the stop duration bin.

• LowerBound (integer) — the lower bound stop duration (non-inclusive).

• UpperBound (integer) — the upper bound stop duration (inclusive).

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

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

• Percentile (integer): the percentile value.

• Value (float): the calculated percentile stop duration value (minutes).

Array of objects representing stop metrics for a day of week, based on the day of week of arrival at the stop location (local time). Each object contains:

• DayOfWeek (integer) — the day of the week.

• StopCount (integer) — number of stops.

• StopCountAvg (integer) — average number of stops during a single instance of the day of week.

• StopCountMed (integer) — median number of stops during a single instance of the day of week.

• VehicleCount (integer) — number of vehicles.

• VehicleCountAvg (integer) — average number of vehicles during a single instance of the day of week.

• VehicleCountMed (integer) — median number of vehicles during a single instance of the day of week

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing stop metrics for each direction of travel on a road segment. Each object contains:

• CardinalDirection (string) — the direction of the road segment in terms of “N”, “NE”, “E” etc.

• Direction (integer) — the direction of travel of the road segment relative to the segment definition.

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Direction — 1 or -1

CardinalDirection — “N”, “S”, “E”, “W”, “NE”, “NW”, “SE” or “SW”

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

• FuelType (string) — fuel type name.

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing stop metrics for an hour, based on the hour of arrival at the stop location (local time). Each object contains:

• Hour (integer) — the hour.

• StopCount (integer) — number of stops.

• StopCountAvg (integer) — average number of stops during a single instance of the hour.

• StopCountMed (integer) — median number of stops during a single instance of the hour.

• VehicleCount (integer) — number of vehicles.

• VehicleCountAvg (integer) — average number of vehicles during a single instance of the hour.

• VehicleCountMed (integer) — median number of vehicles during a single instance of the hour.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing metrics for vehicles parked during an hour (local time). Each object contains:

• Hour (integer) — the hour.

• ParkedCount (integer) — number of distinct parking events.

• ParkedCountAvg (integer) — average number of distinct parking events during a single instance of the hour.

• ParkedCountMed (integer) — median number of distinct parking events during a single instance of the hour.

• VehicleCount (integer) — number of distinct vehicles parked.

• VehicleCountAvg (integer) — average number of distinct vehicles parked during a single instance of the hour.

• VehicleCountMed (integer) — median number of distinct vehicles parked during a single instance of the hour.

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

• NAICS_Code_1 (integer) — NAICS code 1.

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing stop metrics for a month, based on the month of arrival at the stop location (local time). Each object contains:

• Month (integer) — the month.

• StopCount (integer) — number of stops.

• StopCountAvg (integer) — average number of stops during a single instance of the month.

• StopCountMed (integer) — median number of stops during a single instance of the month.

• VehicleCount (integer) — number of vehicles.

• VehicleCountAvg (integer) — average number of vehicles during a single instance of the month.

• VehicleCountMed (integer) — median number of vehicles during a single instance of the month.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing stop 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.

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Array of objects representing stop metrics for each vocation. Each object contains:

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

• Vocation (string) — vocation name.

• StopCount (integer) — number of stops.

• VehicleCount (integer) — number of vehicles.

• StopDurationAvg (float) — average stop duration (minutes).

• StopDurationMed (float) — median stop duration (minutes).

• IdleDurationAvg (float) — average idle duration (minutes).

• IdleDurationMed (float) — median idle duration (minutes).

• PreStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip leading up to the stop.

• PreStopTripDurationAvg (float) — average duration (minutes) of the trip leading up to the stop.

• PreStopTripDistanceMed (float) — median duration (minutes) of the trip leading up to the stop.

• PostStopTripDistanceAvg (float) — average distance (miles or kilometers) of the trip after the stop.

• PostStopTripDistanceMed (float) — median distance (miles or kilometers) of the trip after the stop.

• PostStopTripDurationAvg (float) — average duration (minutes) of the trip after the stop.

• PostStopTripDistanceMed (float) — median duration (minutes) of the trip after the stop.

Description of the zone when available. The is based on the type of zone:

• “State” — state name.

• “County” — county name.

• “City” — city name.

• “CTR” — census tract description.

• “Segment” — road name, if available

• “Custom” — custom zone name.

For all other zones, this attribute is null.

Unique identifier for the zone. This value is set based on the aggregationMode input parameter value: location.

• 0 — road segment unique identifier (SegmentId)

• 1 — related road unique identifier (RelatedRoadId)

• 2 — unique identifier for the standard or custom zones input (ZoneId)

• 3 — H3 level-based identifier

• 4 — Geohash

• 5 — S2 level-based identifier

The zone type subclassification value, where applicable. The zone type of the returned zone. Based on aggregationMode input parameter value:

• 0 — the road type value for the road segment

• 1 — the related road type for the related road

• 2 — null

• 3, 4, 5 — the cell level

• 6 — null

The type of the returned zone. Based on aggregationMode input parameter value:

• 0 — “Segment”

• 1 — “RelatedRoad”

• 2 — “State”, “County”, “City”, “ZIP”, “FSA”, “CTR”, “TAZ”, or “Custom”

• 3 — “H3”

• 4 — “Geohash”

• 5 — “S2”