Get hours of service analytics results

Returns aggregate hours of service information for a given set of parameters. The data insights returned from this endpoint can be used to assess stops for various use cases by leveraging the usage of different geographic aggregation modes.

Altitude Help Center - Stop Analytics API module

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
`cycleStopCountInThreshold`	integer	The number of hours of service stops where the cycle clock had between minHosClockRemaining and maxHosClockRemaining minutes remaining.
`drivingStopCountInThreshold`	integer	The number of hours of service stops where the driving clock had between minHosClockRemaining and maxHosClockRemaining minutes remaining.
`geography`	object	A GeoJSON geometry object representing the zone. Only populated if includeGeography is set to true.
`hosStopCount`	integer	The number of stops in the zone made by vehicles reporting hours of service data.
`hosStopCountInThreshold`	integer	The number of hours of service stops where the driver's lowest remaining clock (driving, workday, or cycle) was between minHosClockRemaining and maxHosClockRemaining minutes.
`iso_3166_2`	string	The ISO 3166:2 code for the state or province associated with the output zone, where available.
`vehicleCount`	integer	The number of unique vehicles with hours of service stops in the zone.
`workdayStopCountInThreshold`	integer	The number of hours of service stops where the workday clock had between minHosClockRemaining and maxHosClockRemaining minutes remaining.
`zoneCode`	string	Raw zone code as reported by the analytics backend. For aggregationMode 3 (H3) this is the raw H3 cell index; 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) and 2 (standard or custom zone). Null for aggregationMode 3 (H3): H3 cells are analytical spatial buckets, not Altitude zones. Use zoneCode to read their raw cell identifier.
`zoneName`	string	Description of the zone when available (e.g. county name, road name, or custom zone name). Null for H3 cells.
`zoneSubType`	string	The zone type subclassification value. Based on aggregationMode: 0 - highway type (e.g. motorway, primary); 2 - null; 3 - H3 resolution level.
`zoneType`	string	The type of the returned zone. Based on aggregationMode: 0 - 'Segment'; 2 - the standard or custom zone type; 3 - 'H3'.

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.