get
/api/v2/zones/metadata/contained-zones/{id}Python SDK method:
client.zone_metadata.contained_zones(id=job_id).results()Get contained zones results
Returns paginated zone metadata records for a completed contained zones job. Each record represents a zone that is geographically contained within the requested parent zones.
Altitude Help Center — getContainedZonesInput Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | The id of the job whose results you want to fetch. | Y |
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 |
|---|---|---|
inputZone | object | Zone identity of the input (parent) zone. |
zone | object | Zone metadata record for a zone contained within or associated with the input zone. |
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. |
