Start AADT job

Creates a job to generate an annual average daily traffic (AADT) analysis. The analysis uses Geotab's statistical modelling to produce AADT estimates per road segment for the selected zones and vehicle class scheme.

Altitude Help Center - AADT

Request Body

AADT analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`isDirectional`	boolean	-	-	When true, one record is returned per direction of travel; when false, results are averaged across both directions.	Y
`roadTypes`	array<RoadType>	-	living_street, motorway, motorway_link, primary, primary_link, residential, road, secondary, secondary_link, service, tertiary, tertiary_link, trunk, trunk_link, unclassified	OSM road types to include. An empty array includes all road types.	N
`year`	integer (int64)	-	-	Calendar year for which AADT values should be returned.	Y
`zoneIds`	array<string>	-	-	Encoded zone ID strings. Provide exactly one of zoneIds or zones (not both).	N
`zones`	array<object>	code: string; iso_3166_2: string; type: string	-	Zone objects with code, type, and iso_3166_2. Provide exactly one of zones or zoneIds (not both).	N

Examples

County AADT request

Translated from the v1 AADT sample.

{
  "isDirectional": true,
  "year": 2025,
  "zones": [
    {
      "code": "13121",
      "iso_3166_2": "US-GA",
      "type": "County"
    }
  ]
}

Success Responses

202 response: object

Job accepted and queued for processing. Poll the location header URL to check status.

Name	Type	Description
`error`	object	Details about why the job failed (RFC 7807 format), or null if it succeeded.
`id`	string	Unique job identifier.
`links`	object	Navigation URLs for polling and result retrieval.
`status`	string	Current job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status Code	Reason
400	The request body or parameters are invalid.
401	Authentication is required or the provided credentials are invalid.
403	The authenticated user lacks permission to perform this operation.
409	The operation conflicts with the current state of the resource.
422	The request is syntactically valid but semantically cannot be processed.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.