get
/api/v2/regional-travel-metrics/modeled-vehicle-distance-traveled/{id}/time-series
Python SDK method:
client.rtm.modeled_vdt(id=job_id).time_series_results()

Get modeled vehicle distance traveled time series results

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

Altitude Help Center — getModeledVehicleDistanceTraveled

Input Parameters

NameLocationTypeValuesDescriptionValue Required
idpathstring-Unique resource identifier.Y
pageTokenquerystring-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.

NameTypeDescription
aggregationUnitstringThe time-based unit by which to aggregate data.
aggregationValuestringThe associated AggregationUnit value.
distanceByVehicleGrouparray<object>Array of objects representing the observed and modeled distance for each vehicle group.
iso_3166_2stringThe ISO 3166:2 code of the zone.
zoneCodestringRaw zone code (e.g. county FIPS, ZIP code, custom zone ID).
zoneIdstringEncoded zone identifier for use in subsequent API requests.
zoneNamestringDescription 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.
zoneTypestringThe zone type of the zone.

Response Errors

HTTP Status CodeReason
400The request body or parameters are invalid.
401Authentication is required or the provided credentials are invalid.
403The authenticated user lacks permission to perform this operation.
404The requested resource does not exist.
409Result not yet ready. Poll the status monitor.
429The request rate limit has been exceeded.
500An unexpected server error occurred.