get
/api/v2/poi/summary/{id}Python SDK method:
client.poi.summary(id=job_id).results()Get Site Intelligence summary results
Returns paginated Site Intelligence summary rows for a completed Site Intelligence summary analysis job. Each row represents aggregated stop statistics for one point-of-interest location.
Altitude Help Center — POI Location Specific Insights APIInput 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 |
|---|---|---|
brands | array<string> | Brands included in the summary. |
competitorDensity | integer | Number of competitor locations around the input Site Intelligence location. |
inputId | string | Input Site Intelligence location identifier used to anchor the analysis. |
inputName | string | Input Site Intelligence location name used to anchor the analysis. |
inputType | string | Input location type for the summary row, typically POI. |
input_iso_3166_2 | string | ISO 3166-2 region code for the input Site Intelligence location. |
isSourceLocation | boolean | Whether the returned Site Intelligence location is the input Site Intelligence location. |
locationAddress | string | Formatted street address for the returned Site Intelligence location. |
locationBrands | array<string> | Brands associated with the returned Site Intelligence location. |
locationId | string | Returned Site Intelligence location identifier. |
locationIsOwned | boolean | Whether the returned Site Intelligence location is owned by the requesting organization. |
locationLatitude | number | Returned Site Intelligence location latitude. |
locationLongitude | number | Returned Site Intelligence location longitude. |
locationNaics | object | NAICS classification for the returned Site Intelligence location. |
locationName | string | Returned Site Intelligence location name. |
location_iso_3166_2 | string | ISO 3166-2 region code for the returned Site Intelligence location. |
naics | object | NAICS classification for the summarized point of interest. |
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. |
