get
/api/v2/regional-travel-metrics/idle-metrics/{id}Python SDK method:
client.rtm.idle_metrics(id=job_id).results()Get idle metrics results
Returns paginated idle duration and idle fuel consumption results for a completed idle metrics job.
Altitude Help Center — getIdleMetricsInput 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 |
|---|---|---|
idleByFuelType | array<object> | Array of objects representing the idle duration and contributing vehicle count for each fuel type. |
idleByIndustry | array<object> | Array of objects representing the idle duration and contributing vehicle count for each NAICS code 1. |
idleByRoadType | array<object> | Array of objects representing the idle duration and contributing vehicle count for each road type. |
idleByVehicleClass | array<object> | Array of objects representing the idle duration and contributing vehicle count for each vehicle class. |
idleByVehicleYear | array<object> | Array of objects representing the idle duration and contributing vehicle count for each vehicle year bucket. |
idleByVocation | array<object> | Array of objects representing the idle duration and contributing vehicle count for each vocation. |
idleDuration | number (double) | The total idle duration (minutes) for this row. |
iso_3166_2 | string | The ISO 3166:2 code of the zone. |
tripCount | integer (int64) | The total number of trips in the zone. |
tripCountTotal | integer (int64) | The total number of trips in the analysis. |
vehicleCount | integer (int64) | The total number of unique vehicles in the zone. |
vehicleCountTotal | integer (int64) | The total number of unique vehicles in the analysis. |
zoneCode | string | Raw zone code. |
zoneId | string | The zone id for which the data is returned. |
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. |
