get
/api/v2/poi/locations/{id}Python SDK method:
client.poi.locations(id=job_id).results()Get point of interest results
Returns paginated POI location rows for a completed Points of Interest locations job. Each row represents a location that has been identified as a point of interest.
Altitude Help Center — POI Location Specific Insights APIInput Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | POI locations job identifier returned by the POST request. | Y |
pageToken | query | string | - | Opaque 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 |
|---|---|---|
address | string | Formatted street address for the location. |
brands | array<string> | Brands associated with the location. |
id | string | Point of interest location identifier. |
isOwned | boolean | Whether the location is owned by the requesting organization. |
iso_3166_2 | string | ISO 3166-2 region code for the location. |
latitude | number (double) | Location latitude in decimal degrees. |
longitude | number (double) | Location longitude in decimal degrees. |
naics | object | NAICS classification for the location. |
name | string | Point of interest location name. |
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. |