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.
Parameters
| Parameter | Description | Type | Defined Value Set | Value Required |
|---|---|---|---|---|
| queryType | Must equal "getModeledAADT". | STRING | "getModeledAADT" | Y |
| isDirectional | Indicates whether AADT should be returned per direction of a road segment (true) or consolidated for the road segment as a whole (false). The default value is false. | BOOLEAN | true or false | Y |
| roadTypes | An 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 AADT values.
Note:
AADT is available at a segment level for 2022, 2023, 2024, and 2025. | INTEGER | [2022:2025] | Y |
| zones |
An array of objects representing the zones for which you want information. Each object contains ZoneId, ISO_3166_2, and ZoneType:
| ARRAY | ZoneType - "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
| Attribute | Description | Data Type | Defined Value Set |
|---|---|---|---|
| AADTbyVehicleGroup |
Array of objects representing the AADT of each vehicle group. Each object contains:
Note:
The prediction interval defines the range within which the true AADT value falls with 90% confidence. The bounds are relative to the estimated AADT value (% of AADT). | ARRAY |
VehicleGroup - Universal: All Geotab vs. market, including both commercial and non-commercial vehicles. Heavy: GVWR 6-8 vs. equivalent commercial market. Medium: GVWR 3-5 vs. equivalent commercial market. EstimateMethod - "observed", "projected" |
| CardinalDirection | The direction of the road segment in terms of "N", "NE", "E", etc. | STRING | ["N", "NE", "E", "SE", "S", "SW", "W", "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. | INTEGER | 1,-1, or 0 |
| ISO_3166_2 | The ISO 3166:2 code of the zone. | STRING | - |
| RoadType | The road type of the returned data as defined by OSM. | STRING | "motorway", "trunk", "primary", "secondary", "tertiary" |
| SegmentId | Segment 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 | - |
| Year | The year of applicability for the AADT value. | INTEGER | - |
| ZoneDescription |
Description of the zone when available. The value is based on the type of zone:
| STRING | - |
| ZoneId | The zone ID for which the data is returned. | STRING | - |
| ZoneType | The zone type of the zone. | STRING | "State", "County", "City", "CTR", "ZIP", "TAZ", "Custom" |
MAPE and RSquared performance metrics are no longer returned in the API response. Customers can request AADT performance metrics for a specific area of interest (AOI) and road type from the Solutions Engineering team.
Sample parameters
{
"isDirectional": false,
"queryType": "getModeledAADT",
"roadTypes": [],
"year": 2025,
"zones": [
{
"ZoneId": "<ZoneId>",
"ISO_3166_2": "<ISO_3166_2>",
"ZoneType": "<ZoneType>"
}
]
}