Start fuel point analytics job

Creates a job to generate a fuel point analytics analysis (beta). Returns vehicle stop events at identified fuel-point locations, including dwell times and vehicle classification breakdowns. Only custom zones are supported; requests with non-custom zone types are rejected.

Altitude Help Center — Fuel Point Analytics (beta)

Request Body

Analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`aggregationUnits`	array<string>	-	hour, dayofweek, week, month, daytype, daytypehour, hourofday, day	Time-series dimensions to generate when generateTimeSeries is true. Valid values: hour, dayofweek, month. An empty array generates all available aggregation units.	N
`dateRanges`	array<object>	dateFrom: string; dateTo: string	-	Date ranges to include in the analysis. Results are aggregated across all ranges. The earliest supported date is January 1, 2025.	Y
`daysOfWeek`	array<integer>	-	1, 2, 3, 4, 5, 6, 7	Days of the week to include (1=Sunday … 7=Saturday). An empty array includes all days.	N
`fuelTypes`	array<string>	-	diesel, electric, flexible, gasoline, hybrid, other, unknown	Fuel types to include. Valid values: diesel, electric, flexible, gasoline, hybrid, other, unknown. An empty array includes all fuel types.	N
`generateTimeSeries`	boolean	-	-	When true, a time-series breakdown child analysis is generated for each aggregation unit. Results are retrievable via GET /api/v2/stop-analytics/fuel-point-analytics/{id}/time-series once the job is complete.	Y
`industries`	array<string>	-	agriculture, mining, utilities, construction, manufacturing, wholesale, retail, transportation_and_warehousing, information_and_cultural, finance_and_insurance, real_estate, science_and_technology, management, administrative_and_support, education, health_care, arts_and_entertainment, accommodation_and_food, public_administration, other_services, unclassified	Named industry IDs from GET /api/v2/filters/industries (e.g. 'manufacturing', 'retail'). Resolved to NAICS codes at query time and combined with any naics values. Leave both industries and naics empty to include all industries.	N
`isMetric`	boolean	-	-	When true, distance values are returned in kilometres; when false, in miles. If omitted, defaults to the isMetric setting on the authenticated user's profile.	N
`maxRefuelStopDuration`	number	-	-	Maximum refuel stop duration (minutes) to be included in the analysis. Defaults to +inf when omitted.	N
`minRefuelStopDuration`	number	-	-	Minimum refuel stop duration (minutes) to be included in the analysis. Defaults to 2 when omitted.	N
`naics`	array<integer>	-	-	Explicit raw NAICS integer codes to filter by. Combined with any industries values. Leave both naics and industries empty to include all industries.	N
`timeFrom`	string	-	-	Start of the time-of-day window (hh:mm:ss or hh:mm:ss.ms). Defaults to 00:00:00 when omitted.	N
`timeTo`	string	-	-	End of the time-of-day window (hh:mm:ss or hh:mm:ss.ms). Defaults to 23:59:59.999 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; IDs that do not name a known vehicle class are rejected. An empty array includes all vehicle classes.	N
`vehicleClassSchemeId`	integer	-	1, 2, 3, 4, 5	Vehicle classification scheme, from 1 through 5. Defaults to 2 (FHWA/GVWR) when omitted.	N
`vehicleClasses`	array<object>	vehicleType: string (values: Truck, Passenger, MPV, Bus, Limo, Other, n/a); weightClass: string (values: *, Class 1, Class 2, Class 3, Class 4, Class 5, Class 6, Class 7, Class 8, Class A, Class B, Class C, Class D, Class E, Class F, Class G, Class H)	-	Vehicle class filters. Use an empty array to include all vehicle classes.	N
`vocations`	array<integer>	-	1, 2, 3, 4, 5	Vocation IDs from GET /api/v2/filters/vocations. An empty array includes all vocations.	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 (values: Country, State, County, City, FSA, ZIP, TAZ, CTR, Custom, Segment, RelatedRoad)	-	Zone objects with code, type, and iso_3166_2. Provide exactly one of zones or zoneIds (not both).	N

Examples

Custom-zone fuel point request

Translated from the v1 getFuelPointAnalytics sample.

{
  "aggregationUnits": [
    "hour"
  ],
  "dateRanges": [
    {
      "dateFrom": "2026-01-01",
      "dateTo": "2026-01-31"
    }
  ],
  "generateTimeSeries": true,
  "timeFrom": "00:00:00",
  "timeTo": "23:59:59.999",
  "zones": [
    {
      "code": "xx-xxxxxxxxxxxx",
      "type": "Custom"
    }
  ]
}

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.