Get expansion factors

Returns expansion factors for state and county zones. Filter by year, road type, vehicle group, zone type, purchased access, or exact zone selectors. Results are sorted by expansion factor ID before pagination. Expansion factors are statistical multipliers used to scale Geotab-observed vehicle counts to estimated commercial-market vehicle counts.

Altitude Help Center — getExpansionFactors

Input Parameters

Name	Location	Type	Values	Description	Value Required
`pageToken`	query	string	-	Pagination token from the Link header of a previous response. Omit for the first page.	N
`pageSize`	query	integer (int64)	-	Maximum number of items to return per page (1-20000). Defaults to the maximum when omitted.	N

Request Body

Expansion factor filters and optional exact zone selectors.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`isPurchased`	boolean	-	-	When true, return only expansion factors for zones purchased by the authenticated database.	N
`roadType`	string	-	motorway, trunk, primary, secondary, tertiary, motorway_link, trunk_link, primary_link, secondary_link, tertiary_link, living_street, residential, service, unclassified, road, all	OSM road type to include. Use 'all' for aggregate factors or omit to include every road type.	N
`vehicleGroup`	string	-	heavy, medium, universal	Vehicle group to include: heavy, medium, or universal. Omit to include every vehicle group.	N
`year`	integer (int64)	-	-	Calendar year to include. Omit to include all available years.	N
`zoneIds`	array<string>	-	-	Encoded state or county zone IDs to match exactly.	N
`zoneType`	string	-	State, County	Zone type to include: State or County. Omit to include both.	N
`zones`	array<object>	code: string; iso_3166_2: string; type: string	-	State or county zone objects to match exactly.	N

Examples

County expansion factors request

{
  "roadType": "motorway",
  "vehicleGroup": "universal",
  "year": 2024,
  "zones": [
    {
      "code": "32003",
      "iso_3166_2": "US-NV",
      "type": "County"
    }
  ]
}

Success Responses

200 response: object

OK.

Name	Type	Description
`ci95All`	number (double)	95% confidence interval half-width for the expansion factor.
`factor`	number (double)	Rounded expansion factor value.
`filterId`	string	Stable filter identifier composed from year, vehicle group, and road type.
`id`	string	Unique expansion factor identifier composed from filter ID and zone ID.
`isEstimated`	boolean	When true, the expansion factor was estimated rather than directly measured.
`isPurchased`	boolean	When true, the requesting database has purchased this zone.
`iso_3166_2`	string	ISO 3166-2 state/province code for this record.
`lower`	number (double)	Lower bound of the expansion factor confidence interval.
`mape`	number (double)	Mean absolute percentage error for the expansion factor estimate.
`marketShare`	number (double)	Market share used when computing the expansion factor.
`roadType`	string	OSM road classification for which the expansion factor applies.
`upper`	number (double)	Upper bound of the expansion factor confidence interval.
`vehicleGroup`	string	Vehicle group for which the expansion factor applies.
`year`	integer (int64)	Calendar year for which the expansion factor was computed.
`zoneCode`	string	Zone identifier code (e.g. county FIPS, ZIP code) for this record.
`zoneId`	string	Encoded zone identifier.
`zoneName`	string	Human-readable display name of the zone.
`zoneType`	string	Zone type (e.g. 'County', 'ZIP', 'State').

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.
404	The requested resource does not exist.
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.