Start stop events job

Creates a job to generate a stop analytics analysis. Returns stop event records for vehicles that stopped in the specified zones during the date/time window, with filters for industry, vocation, and vehicle class.

Altitude Help Center — getStopAnalytics

Request Body

Analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`aggregationMode`	integer	-	-	Geographic aggregation mode: 0=road segment, 1=related roads, 2=zone, 3=H3, 4=geohash, 5=S2.	Y
`dateRanges`	array<object>	dateFrom: string (date); dateTo: string (date)	-	Date ranges to include in the analysis. Results are aggregated across all ranges.	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
`hashHierarchy`	boolean	-	-	When true, returns the hierarchy of spatial hash cells rather than each level separately. Applies only to aggregation modes 3 (H3), 4 (geohash), and 5 (S2).	N
`includeGeography`	boolean	-	-	When true, includes GeoJSON geography in the response. Forced true for aggregation modes 3, 4, and 5. Defaults to false for all other modes.	N
`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. Defaults to the unit setting in your user profile when omitted.	N
`maxCellLevel`	integer	-	-	Maximum cell level for H3, geohash, or S2 aggregation modes. Defaults to 10 for H3, 7 for geohash, and 16 for S2.	N
`maxPostStopTripDistance`	number	-	-	Maximum distance (miles or km) of the trip after the stop to be included in the analysis. Defaults to +inf when omitted.	N
`maxPostStopTripDuration`	number	-	-	Maximum duration (minutes) of the trip after the stop to be included in the analysis. Defaults to +inf when omitted.	N
`maxPreStopTripDistance`	number	-	-	Maximum distance (miles or km) of the trip before the stop to be included in the analysis. Defaults to +inf when omitted.	N
`maxPreStopTripDuration`	number	-	-	Maximum duration (minutes) of the trip leading up to the stop to be included in the analysis. Defaults to +inf when omitted.	N
`maxStopDuration`	number	-	-	Maximum stop duration (minutes) to be included in the analysis. Defaults to +inf when omitted.	N
`minCellLevel`	integer	-	-	Minimum cell level for H3, geohash, or S2 aggregation modes. Defaults to 5 for H3, 5 for geohash, and 10 for S2.	N
`minPostStopTripDistance`	number	-	-	Minimum distance (miles or km) of the trip after the stop to be included in the analysis. Defaults to 0.	N
`minPostStopTripDuration`	number	-	-	Minimum duration (minutes) of the trip after the stop to be included in the analysis. Defaults to 0.	N
`minPreStopTripDistance`	number	-	-	Minimum distance (miles or km) of the trip before the stop to be included in the analysis. Defaults to 0.	N
`minPreStopTripDuration`	number	-	-	Minimum duration (minutes) of the trip leading up to the stop to be included in the analysis. Defaults to 0.	N
`minStopCount`	integer	-	-	Minimum number of stops an output zone must have to be included in the results.	N
`minStopDuration`	number	-	-	Minimum stop duration (minutes) to be included in the analysis. Defaults to 0.	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
`percentiles`	array<integer>	-	-	Integer percentiles to compute for stop and trip metrics (for example 10, 50 and 90). Defaults to the 15th and 85th percentiles when omitted.	N
`relatedRoadTypes`	array<string>	-	living_street, motorway, motorway_link, primary, primary_link, residential, road, secondary, secondary_link, service, tertiary, tertiary_link, trunk, trunk_link, unclassified	Related road types to include. Applies only when aggregationMode is 1. Omit or send an empty array to include all road types.	N
`roadTypes`	array<string>	-	living_street, motorway, motorway_link, primary, primary_link, residential, road, secondary, secondary_link, service, tertiary, tertiary_link, trunk, trunk_link, unclassified	Road types to include. Applies only when aggregationMode is 0. Omit or send an empty array to include all road types.	N
`stopDurationBins`	array<integer>	-	-	Upper bounds (inclusive, minutes) of stop duration bins. For example, 10, 30 and 60 create the bins up to 10, 10–30, 30–60 and over 60.	N
`timeFrom`	string	-	-	Start of the time-of-day window, formatted as hh:mm:ss. Defaults to 00:00:00 when omitted.	N
`timeTo`	string	-	-	End of the time-of-day window (hh:mm:ss). 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, 6	Vehicle classification scheme: 1 = VIUS, 2 = GVWR (FHWA), 3 = Truck Weight Classes, 4 = CARB, 5 = Gross Weight Group (custom scheme), 6 = Expansion Factors (custom scheme). Defaults to 2 when omitted. See GET /api/v2/filters/vehicle-class-schemes.	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>	-	-	Zones to include, as encoded zone IDs. Provide exactly one of zoneIds or zones (not both).	N
`zones`	array<object>	code: string; iso_3166_2: string; type: string (values: State, County, City, FSA, ZIP, TAZ, CTR, Custom)	-	Zones to include, each identified by a code, a zone type and a state or province code (iso_3166_2). Provide exactly one of zones or zoneIds (not both).	N

Examples

County stop events request

Translated from the v1 getStopAnalytics sample.

{
  "aggregationMode": 2,
  "dateRanges": [
    {
      "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.