queryType: getIdleMetrics*

Whether to aggregate the results over all zones (true) or report the results for each zone provided (false). The default is false.

Array of 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 - for a breakdown by hour from 0 to 23.

• daytype - for a breakdown by day-of-week, where “Weekend” = [1,7] or Saturday through Sunday, and “Weekday” = [2,3,4,5,6] or Monday through Friday.

• daytypehour - for a breakdown by day type (“Weekend”, “Weekday”) and hour from 0 to 23.

The default is [“hour”, “daytype”, “daytypehour”].

“hour”,

“daytype”,

“daytypehour”

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

The time series breakdown results can be retrieved using the getSavedResults API. See for more details.

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.

Array of objects representing bin definitions for histogram of vehicle years of the vehicle classes selected. There should be an object for each desired bin for the IdleByVehicleYear output attribute. Each object contains:

• LowerBound (integer) - lower bound of the bucket.

• UpperBound (integer) - upper bound of the bucket.

For example: [{"LowerBound": 2017, "UpperBound": 2020}, {"LowerBound":2021, "UpperBound": 2022}] will produce 3 objects in the DistanceByVehicleYear field for 2017-2020, 2021-2022 and all others.

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.

The total idle duration (minutes) in the zone before turning off the ignition at the end of a trip or idling at the start of a trip, summing all vehicle observations in the analysis. Refer to Stop Definition in the Data dictionary to understand more.

Array of objects representing the idle duration and contributing vehicle count for each fuel type. Each object contains:

• FuelType (string) - fuel type name.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count for each NAICS code 1. Each object contains:

• NAICS_Code_1 (integer) - NAICS code 1.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count for each road type. Each object contains:

• RoadType (string) - road type name.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count 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.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count for each vehicle year bucket. Each object contains:

• VehicleYear (string) - a string representation of the vehicle year bucket.

• LowerBound (integer) - the lower bound year.

• UpperBound (integer) - the upper bound year.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count for each vocation. Each object contains:

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

• Vocation (string) - vocation name.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

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

• "Hour"

• "DayOfWeek"

• "Month"

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, e.g. 1 or 16

• dayofweek - numeric value for day of week where Sunday is 1 and Saturday is 7

• month - number of the month, e.g. 1 or 12

The total idle duration (minutes) in the zone before turning off the ignition at the end of a trip or idling at the start of a trip, summing all vehicle observations in the analysis. Refer to Stop Definition to understand more.

Array of objects representing the idle duration and contributing vehicle count for each fuel type. Each object contains:

• FuelType (string) - fuel type name.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count 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.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

Array of objects representing the idle duration and contributing vehicle count for each vocation. Each object contains:

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

• Vocation (string) - vocation name.

• TripCount (integer) - number of trips.

• VehicleCount (integer) - number of vehicles.

• IdleDuration (float) - the total idle duration (minutes).

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