Get stop events results

Returns paginated stop event rows for a completed stop analytics job. Each row represents one stop event for a vehicle in one zone.

Altitude Help Center — getStopAnalytics

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
`geography`	object	A GeoJSON geometry object representing the zone. Only populated if includeGeography is set to true.
`idleDurationAvg`	number	The average idle duration (minutes) before turning off ignition at the stop location.
`idleDurationMed`	number	The median idle duration (minutes) before turning off ignition at the stop location.
`idleDurationPercentiles`	array<object>	Array of objects representing percentile idle duration values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`idleDurationStdev`	number	The standard deviation of idle duration (minutes) before turning off ignition at the stop location.
`isOneWay`	boolean	Whether the road segment is one-way (true) or not (false). A value of true or false is only returned when the zone type is Segment (aggregationMode 0). Null is returned for all other zone types.
`iso_3166_2`	string	The ISO 3166:2 code for the state or province associated with the output zone, where available.
`postStopTripDistanceAvg`	number	The average distance (miles or kilometers) of the trip after the stop.
`postStopTripDistanceMed`	number	The median distance (miles or kilometers) of the trip after the stop.
`postStopTripDistancePercentiles`	array<object>	Array of objects representing percentile trip distance values for the trip after the stop, for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`postStopTripDistanceStdev`	number	The standard deviation of distance (miles or kilometers) of the trip after the stop.
`postStopTripDurationAvg`	number	The average duration (minutes) of the trip after the stop.
`postStopTripDurationMed`	number	The median duration (minutes) of the trip after the stop.
`postStopTripDurationPercentiles`	array<object>	Array of objects representing percentile trip duration values for the trip after the stop, for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`postStopTripDurationStdev`	number	The standard deviation of duration (minutes) of the trip after the stop.
`preStopTripDistanceAvg`	number	The average distance (in km or mi) of the trip leading to the stop.
`preStopTripDistanceMed`	number	The median distance (in km or mi) of the trip leading to the stop.
`preStopTripDistancePercentiles`	array<object>	Array of objects representing percentile trip distance values for the trip leading up to the stop, for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`preStopTripDistanceStdev`	number	The standard deviation of distance (in km or mi) of the trip leading to the stop.
`preStopTripDurationAvg`	number	The average duration (minutes) of the trip leading to the stop.
`preStopTripDurationMed`	number	The median duration (minutes) of the trip leading to the stop.
`preStopTripDurationPercentiles`	array<object>	Array of objects representing percentile trip duration values for the trip leading up to the stop, for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`preStopTripDurationStdev`	number	The standard deviation of duration (minutes) of the trip leading to the stop.
`stopCount`	integer	The number of stop events occurring at the stop location.
`stopDurationAvg`	number	The average stop duration (minutes).
`stopDurationBins`	array<object>	Array of objects representing count metrics for stop duration bins.
`stopDurationMed`	number	The median stop duration (minutes).
`stopDurationPercentiles`	array<object>	Array of objects representing percentile stop values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default.
`stopDurationStdev`	number	The standard deviation of stop duration (minutes).
`stopMetricsByDayOfWeek`	array<object>	Array of objects representing stop metrics for each day of week, based on the day of arrival at the stop location (local time).
`stopMetricsByDirection`	array<object>	Array of objects representing stop metrics for each direction of travel on a road segment. Only returned for aggregationMode 0.
`stopMetricsByFuelType`	array<object>	Array of objects representing stop metrics for each fuel type.
`stopMetricsByHour`	array<object>	Array of objects representing stop metrics for each hour, based on the hour of arrival at the stop location (local time).
`stopMetricsByHourParked`	array<object>	Array of objects representing metrics for vehicles parked during each hour (local time). A parking event is included if it parked for any portion of the hour.
`stopMetricsByIndustry`	array<object>	Array of objects representing stop metrics for each NAICS code 1.
`stopMetricsByMonth`	array<object>	Array of objects representing stop metrics for each month, based on the month of arrival at the stop location (local time).
`stopMetricsByVehicleClass`	array<object>	Array of objects representing stop metrics for each vehicle class.
`stopMetricsByVocation`	array<object>	Array of objects representing stop metrics for each vocation.
`vehicleCount`	integer	The number of unique vehicles contributing to the stop count.
`vehicleCountTotal`	integer	The total number of unique vehicles in the entire analysis (not just one zone).
`vocationFilter`	array<integer>	User input vocation filter identifiers.
`zoneCode`	string	Raw zone code as reported by the analytics backend. For aggregationMode 3 (H3), 4 (Geohash), and 5 (S2) this is the raw spatial cell key (e.g. an H3 index, geohash string, or S2 cell token); it is an analytical cell identifier only and cannot be submitted to /zones.
`zoneId`	string	Encoded Altitude zone identifier, reusable in other Altitude API requests. Populated for aggregationMode 0 (road segment), 1 (related road), and 2 (standard or custom zone). Null for aggregationMode 3 (H3), 4 (Geohash), and 5 (S2): these are analytical spatial buckets, not Altitude zones, and have no encoded zoneId. Use zoneCode to read their raw cell identifier.
`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, 'CTR' — census tract description, 'Segment' — road name if available, 'Custom' — custom zone name. For all other zones, this attribute is null.
`zoneSubType`	string	The zone type subclassification value. Based on aggregationMode: 0 — highway type (e.g. motorway, primary); 1 — related road highway type; 2 — null; 3 — H3 resolution level; 4 — Geohash string length; 5 — S2 cell level.
`zoneType`	string	The type of the returned zone. Based on aggregationMode: 0 — 'Segment'; 1 — 'RelatedRoad'; 2 — standard or custom zone type; 3 — 'H3'; 4 — 'Geohash'; 5 — 'S2'.

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.