queryType: getModeledAADT*

The getModeledAADT queryType is passed to the API to get modeled segment-level market AADT for segments related to the input geospatial zone context.

Note:

See Special Case APIs for more information.

Parameters

ParameterDescriptionTypeDefined Value SetValue Req'd
queryTypeMust equal "getModeledAADT".STRING“getModeledAADT"Y
isDirectionalFalse means we ignore the direction of the road segment(s) and send back the sum of all directions. True means you get one set of data for each direction of the road segment.BOOLEANtrue or falseY
roadTypesAn array of strings representing the different road types for which you want data. An empty array means all available road types.ARRAY“motorway”, ”trunk”, “primary”, “secondary”, “tertiary”N
year
The year for which you would like expansion factors.
Note:

AADT is available at a segment level for 2022.

INTEGER2022Y
zones

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, a related road 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.
    Note:

    Restricted to USA zones only.

ARRAYZoneType - “State”, “County”, “City”, “TAZ”, “CTR”, “ZIP”, “FSA”, “Segment”, “Custom”. See Zones for details on how to structure the zone inputs for each zone type.Y

Response Schema

AttributeDescriptionData TypeDefined Value Set
CardinalDirectionThe direction of the road segment in terms of “N”, “NE”, “E”, etc.STRING“N”, “NE”, “E”, SE”, “S”, “SW”, “W” or “NW”
Direction
The direction of travel of the road segment, either 1 or -1.
Note:

For non-directional analysis (isDirectional = FALSE), 0 will be populated for this value.

INTEGER1,-1, or 0
ISO_3166_2The ISO 3166:2 code of the zone.STRING-
MAPEThe mean absolute % error, inferred from the model results for state and road type.FLOAT-
AADTbyVehicleGroup

Array of objects representing the AADT of each vehicle group. Each object contains:

  • VehicleGroup (string) - vehicle group name.

  • AADT (integer) - annual average daily traffic value

ARRAY

VehicleGroup -

Universal: All Geotab vs. market, including both commercial and non-commercial vehicles.

Heavy: GVWR 7-8 vs. equivalent commercial market.

Medium: GVWR 3-6 vs. equivalent commercial market.

RSquared
The r2 value or % variance that is addressed by AADT Model, inferred from the model results for state and road type.
Note:

Where no ground truth data is available for state, the value is inferred from the model results for the road type.

FLOAT-
RoadTypeThe road type of the returned data as defined by OSM.STRING“motorway”, ”trunk”, “primary”, “secondary”, “tertiary”
SegmentIdSegment ID (also known as a Geotab edge ID, that results from breaking down OSM ways into smaller road segments) or unique identifier for the segment.STRING-
YearThe year of applicability for the expansion factor.INTEGER-
ZoneDescription

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

  • “State” - state name

  • “County” - county name

  • “City” - city name

  • “CTR” - census tract description

STRING-
ZoneIdThe zone ID for which the data is returned.STRING-
ZoneTypeThe zone type of the zone.STRING“State”, ”County”, ”City”, ”CTR”, ”ZIP”, “TAZ”, “Custom”

Sample parameters

{
	"isDirectional": false,
"queryType": "getModeledAADT",	
"roadType": [],
	"year": 2022,
	"zones": [
		{
			"ZoneId": "<ZoneId>",
			"ISO_3166_2": "<ISO_3166_2>",
			"ZoneType": "<ZoneType>",
		}
	]
}