get
/api/v2/stop-analytics/fuel-point-analytics/{id}Python SDK method:
client.stop_analytics.fuel_point_analytics(id=job_id).results()Get fuel point analytics results
Returns paginated fuel point analytics rows for a completed fuel point analytics job. Each row represents a vehicle stop at a fuel-point location.
Altitude Help Center — Fuel Point Analytics (beta)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 |
|---|---|---|
dailyRefuelCountAvg | number (double) | The average daily number of refuel events at this location. |
iso_3166_2 | string | The ISO 3166:2 code for the state or province of this zone. |
refuelCount | integer (int64) | The number of observed refuel events at this location. |
refuelMetricsByFuelType | array<object> | Array of objects representing refuel metrics broken down by fuel type. |
refuelMetricsByIndustry | array<object> | Array of objects representing refuel metrics broken down by industry. |
refuelMetricsByVehicleClass | array<object> | Array of objects representing refuel metrics broken down by vehicle class. |
refuelMetricsByVocation | array<object> | Array of objects representing refuel metrics broken down by vocation. |
stopCount | integer (int64) | The number of observed stop events at this location. |
vehicleCount | integer (int64) | The number of unique vehicles observed at this location. |
zoneCode | string | Raw zone code for this result row. |
zoneId | string | Encoded Altitude zone identifier for this result row. |
zoneName | string | Description of the zone when available. |
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. |
