Get fuel economy results

Returns paginated fuel economy rows for a completed fuel economy job. Each row represents aggregated fuel economy for one zone/vehicle-class combination.

Altitude Help Center — getFuelEconomy

Input Parameters

Name	Location	Type	Values	Description	Value Required
`id`	path	string	-	Unique resource identifier.	Y
`pageToken`	query	string	-	Pagination token returned in the Link header of a previous response. Omit to fetch the first page.	N

Success Responses

200 response: object

Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.

Name	Type	Description
`categoryIndex`	integer (int64)	Identifier for the vehicle class category.
`fuelEconomy`	number (double)	Calculated fuel economy (mpg or l/100km).
`fuelEconomyByFuelType`	array<object>	Array of objects representing the fuel economy for each fuel type.
`fuelEconomyByVehicleYear`	array<object>	Array of objects representing the fuel economy for each vehicle year bucket.
`iso_3166_2`	string	The state ISO code of the returned zone.
`schemeId`	integer (int64)	Unique identifier for the vehicle class scheme. See Vehicle class schemas for more detailed information.
`vehicleClass`	string	The vehicle class for which the data is returned.
`vehicleClassId`	string	Stable vehicle class identifier.
`vehicleClassIndex`	integer (int64)	Unique identifier for the vehicle class.
`zoneCode`	string	Raw zone code (e.g. county FIPS, ZIP code, custom zone ID).
`zoneId`	string	Encoded zone identifier for use in subsequent API requests.
`zoneName`	string	Description of the zone when available. The value is based on the type of zone: 'State' — state name, 'County' — county name, 'City' — city name.
`zoneType`	string	The zone type of the zone.

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.
409	Result not yet ready. Poll the status monitor.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.