Get idle metrics time-series results

Returns paginated time-series idle metrics for a completed idle metrics time-series job. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.

Altitude Help Center — getIdleMetrics

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
`aggregationUnit`	string	The time-based unit by which to aggregate data (e.g. 'Hour', 'DayOfWeek', 'Month').
`aggregationValue`	string	The associated AggregationUnit value. Format depends on AggregationUnit: hour — number 0–23; dayofweek — 1 (Sunday) to 7 (Saturday); month — month number 1–12.
`idleByFuelType`	array<object>	Array of objects representing the idle duration and contributing vehicle count for each fuel type for this aggregation bucket.
`idleByVehicleClass`	array<object>	Array of objects representing the idle duration and contributing vehicle count for each vehicle class for this aggregation bucket.
`idleByVocation`	array<object>	Array of objects representing the idle duration and contributing vehicle count for each vocation for this aggregation bucket.
`idleDuration`	number (double)	The total idle duration (minutes) in the zone for the aggregation bucket before turning off the ignition at the end of a trip or idling at the start of a trip. Mid-trip idling is not included.
`iso_3166_2`	string	The ISO 3166:2 code of the zone.
`tripCount`	integer (int64)	The total number of trips for the aggregation unit and aggregation value.
`vehicleCount`	integer (int64)	The total number of unique vehicles for the aggregation unit and aggregation value.
`zoneCode`	string	Raw zone code (e.g. county FIPS, ZIP code, custom zone ID).
`zoneId`	string	Encoded zone identifier for use in subsequent API requests.
`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.
`zoneType`	string	The zone type of the zone.

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.