get
/api/v2/analyses/geography/{id}

Get analysis geography results

Returns a page of the zones of a saved analysis, each with its GeoJSON geometry, once the geography job has completed.

Altitude Help Center — getGeography

Input Parameters

NameLocationTypeValuesDescriptionValue Required
idpathstring-The id of the job whose results you want to fetch.Y
pageTokenquerystring-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.

NameTypeDescription
asOfDatestring (date)The date the map snapshot for this zone's geometry was created, formatted as yyyy-mm-dd.
geometryobjectGeoJSON geometry object representing the zone boundary.
iso_3166_2stringThe ISO 3166-2 code for the state or province.
zoneCodestringRaw zone identifier code (e.g. FIPS code for counties, ZIP/postal code, segment ID).
zoneIdstringAltitude zone ID of the zone.
zoneTypestringZone type of the zone.

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.
404The requested resource does not exist.
409Result not yet ready. Poll the status monitor.
429The request rate limit has been exceeded.
500An unexpected server error occurred.