Get closed OD matrix time-series results

Returns paginated time-series journey metric rows for a completed closed OD time-series child analysis. Each row represents one O/D pair at one aggregation-unit bucket. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.

Altitude Help Center — Closed OD API

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
`aggregationDateRanges`	array<object>	Date ranges included in the aggregation.
`aggregationUnit`	string	Time aggregation unit.
`aggregationValue`	string	Time aggregation bucket value.
`destinationCode`	string	Raw destination zone code (e.g. county FIPS, ZIP code, custom zone ID).
`destinationId`	string	Encoded destination zone identifier for use in subsequent API requests.
`destinationName`	string	Destination zone description.
`destinationType`	string	Destination zone type.
`destination_iso_3166_2`	string	ISO 3166-2 state/province code of the destination zone.
`durationAtDestinationAvg`	number (double)	Average duration at destination (minutes).
`durationAtDestinationMed`	number (double)	Median duration at destination (minutes).
`interTripStopDurationAvg`	number (double)	Average inter-trip stop duration (minutes).
`interTripStopDurationMed`	number (double)	Median inter-trip stop duration (minutes).
`journeyCount`	integer (int64)	Observed journey count.
`journeyDistanceAvg`	number (double)	Average journey distance (miles or kilometers, according to isMetric).
`journeyDistanceMed`	number (double)	Median journey distance (miles or kilometers, according to isMetric).
`journeyDurationAvg`	number (double)	Average journey duration (minutes).
`journeyDurationMed`	number (double)	Median journey duration (minutes).
`originCode`	string	Raw origin zone code (e.g. county FIPS, ZIP code, custom zone ID).
`originId`	string	Encoded origin zone identifier for use in subsequent API requests.
`originName`	string	Origin zone description.
`originType`	string	Origin zone type.
`origin_iso_3166_2`	string	ISO 3166-2 state/province code of the origin zone.
`zonePairId`	string	Origin-destination zone pair identifier.

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.