routing

`POST /v1/route/observations` (see module docs).

post/v1/route/observations

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/route/observations
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Request body

geometry_polyline6string required

The route shape as a Google encoded polyline, six-digit precision, typically geometry_polyline6 straight out of a prior /route response.

max_observationsinteger nullable

Ceiling on how many observations come back (1 to 200, default 40).

min_gap_mnumber double nullable

Least distance along the route between two observations, metres (default 2000). This is a floor, not a target: when a route holds more observations than max_observations, the gap widens beyond this on its own so the survivors stay spread over the whole journey.

unitsstring nullable

Units for spoken distances: miles (the default), or kilometers, spelled as the routing engine spells it so a body pasted from a /route request works. kilometres and km are accepted too.

Response

Observations in route order, each with at_m, a kind, the map's own subject name, a say sentence short enough to speak, and the basis the claim rests on; plus a coverage census of what the data could and could not answer (including tiles_missing against tiles_unreadable, and elevation_source: model, disabled or unavailable), the attribution both source licences require, and the standing caveat

object required

Changes

No recorded changes to this operation across all 1 revision of this API.