post
/api/v2/analyses/geography

Start analysis geography job

Creates a job that returns the zones of a saved analysis with their geometry. Retrieve results from GET /api/v2/analyses/geography/{id}.

Altitude Help Center — getGeography

Request Body

Geography job parameters.

application/json: object

NameTypeInput ShapeValuesDescriptionValue Required
analysisIdstring--ID of the saved analysis whose zones should be returned.Y

Success Responses

202 response: object

Job accepted and queued for processing. Poll the location header URL to check status.

NameTypeDescription
errorobjectDetails about why the job failed (RFC 7807 format), or null if it succeeded.
idstringUnique job identifier.
linksobjectNavigation URLs for polling and result retrieval.
statusstringCurrent job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status CodeReason
400The request body or parameters are invalid.
401Authentication is required or the provided credentials are invalid.
403The authenticated user lacks permission to perform this operation.
409The operation conflicts with the current state of the resource.
422The request is syntactically valid but semantically cannot be processed.
429The request rate limit has been exceeded.
500An unexpected server error occurred.