Get POI analytics results

Returns paginated POI analytics rows for a completed POI analytics analysis job.

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
`competitorDensity`	integer (int64)	Number of competitor locations around the input POI location.
`displacement`	number (double)	Distance from the input POI location (miles or kilometers, according to isMetric).
`fleetSizeBins`	array<object>	Fleet size histogram buckets.
`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 analytics row, typically POI.
`input_iso_3166_2`	string	ISO 3166-2 region code for the input POI location.
`isSourceLocation`	boolean	Whether the returned POI location is the input POI location.
`locationAddress`	string	Formatted street address for the returned POI location.
`locationBrands`	array<string>	Brands associated with the returned POI location.
`locationId`	string	Returned POI location identifier.
`locationIsOwned`	boolean	Whether the returned POI location is owned by the requesting organization.
`locationLatitude`	number (double)	Returned POI location latitude.
`locationLongitude`	number (double)	Returned POI location longitude.
`locationNaics`	object	NAICS classification for the returned POI location.
`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).
`stopDurationStdev`	number (double)	Stop duration standard deviation (minutes).
`tradeAreaStopCountTotal`	integer (int64)	Total stops in the trade area around the input POI location.

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.