Get POI analytics time series results

Returns paginated time-series POI analytics rows for a completed POI analytics time-series child analysis. Each row represents aggregated POI analytics for one location at one aggregation-unit bucket. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.

Altitude Help Center — POI Location Specific Insights 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
`aggregationUnit`	string	Time aggregation unit.
`aggregationValue`	string	Time aggregation bucket value.
`inputId`	string	Input POI location identifier used to anchor the analysis.
`inputName`	string	Input POI location name used to anchor the analysis.
`inputType`	string	Input location type for the time-series row, typically POI.
`input_iso_3166_2`	string	ISO 3166-2 region code for the input POI location.
`locationId`	string	Returned POI location identifier.
`locationName`	string	Returned POI location name.
`location_iso_3166_2`	string	ISO 3166-2 region code for the returned POI location.
`stopCount`	integer (int64)	Observed stop count.
`stopCountByFuelType`	array<object>	Stop count breakdown by fuel type.
`stopCountByVehicleClass`	array<object>	Stop count breakdown by vehicle class.
`stopCountByVocation`	array<object>	Stop count breakdown by vocation.
`stopDurationAvg`	number (double)	Average stop duration (minutes).
`stopDurationBins`	array<object>	Stop duration histogram buckets.
`stopDurationMed`	number (double)	Median stop duration (minutes).

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.