Start fuel economy job

Creates a job to generate a fuel economy analysis. Returns average fuel economy values for vehicles in the selected zones, broken down by fuel type, vehicle year, and vehicle class scheme.

Altitude Help Center — getFuelEconomy

Request Body

Fuel economy analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`aggregateAllZones`	boolean	-	-	When true, results are aggregated across all selected zones into a single row.	N
`dateFrom`	string	-	-	First date of the analysis range, formatted as yyyy-mm-dd.	Y
`dateTo`	string	-	-	Last date of the analysis range (inclusive), formatted as yyyy-mm-dd.	Y
`isMetric`	boolean	-	-	When true, fuel economy values are returned in L/100 km; when false, in MPG. Defaults to the isMetric setting on the authenticated user's profile when omitted.	N
`vehicleClassIds`	array<string>	-	-	Vehicle class filter IDs from GET /api/v2/filters/vehicle-classes. IDs must use the scheme_vehicleClassIndex_categoryIndex format and share one scheme. An empty array includes all vehicle classes.	N
`vehicleClassSchemeId`	integer	-	-	Vehicle classification scheme, from 1 through 5. Defaults to 2 (FHWA/GVWR) when omitted.	N
`vehicleClasses`	array<object>	vehicleType: string; weightClass: string	-	Vehicle class filters. Use an empty array to include all vehicle classes.	N
`vehicleYears`	array<object>	lowerBound: integer (int64); upperBound: integer (int64); year: integer (int64)	-	Vehicle model-year range filters. An empty array includes all model years.	N
`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 fuel economy request

Translated from the v1 getFuelEconomy sample.

{
  "dateFrom": "2026-01-01",
  "dateTo": "2026-01-31",
  "isMetric": false,
  "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.