Get vehicle distance traveled time series results

Returns paginated time-series vehicle distance traveled rows for a completed VDT time-series child analysis. Each row represents distance statistics for one zone at one aggregation-unit bucket. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.

Altitude Help Center — getVehicleDistanceTraveled

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.
`aggregationValue`	string	The associated aggregation unit value.
`distance`	number (double)	The distance traveled in this aggregation bucket (miles or kilometers).
`distanceByFuelType`	array<object>	Array of distance, trip count, and vehicle count metrics for each fuel type.
`distanceByVehicleClass`	array<object>	Array of distance, trip count, and vehicle count metrics for each vehicle class.
`distanceByVocation`	array<object>	Array of distance, trip count, and vehicle count metrics for each vocation.
`iso_3166_2`	string	The ISO 3166:2 code of the zone.
`tripCount`	integer (int64)	The number of unique trips in this aggregation bucket.
`vehicleCount`	integer (int64)	The number of unique vehicles in this aggregation bucket.
`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.
`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.