get
/api/v2/zones/custom/batches/{id}Python SDK method:
client.zones.custom_zone_batch(id=job_id).results()Get batch create results
Returns paginated per-zone results for a completed custom zone batch job. Each row reports the outcome of a single zone, including any validation errors. Serves batches started inline and those started from an uploaded file import.
Input Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | The id of the job whose results you want to fetch. | 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 |
|---|---|---|
comments | string | Notes about the zone, if provided in the uploaded file. |
customerZoneId | string | Customer-defined external identifier for the zone, if provided in the uploaded file. |
errors | array<string> | Validation or processing errors for this zone. Empty when the zone imported successfully. |
geography | string | GeoJSON geometry string for the zone. |
status | integer (int64) | Outcome status for this zone: 1 = created, 0 = failed. |
zoneId | string | Identifier of the created custom zone. Empty if the zone failed to import. |
zoneName | string | Display name of the zone from the uploaded file. |
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. |