Tiles

Cluster Tile Endpoint

Changed on

Serve a server-side clustered vector tile for a point dataset.

URL pattern: /tiles/clusters/data.{table_name}/{z}/{x}/{y}.pbf

Authorization matches the plain vector tile route, in three cases. A public, published dataset is readable without credentials. A non-public dataset needs valid signature parameters (sig, exp, scope), an embed token scoped to it, or an API key (X-Api-Key header or api_key query parameter) or bearer token for a caller with access to it. It answers 403 to a request carrying none of these and 404 to a caller without access. A public dataset that is not yet published is readable by its owner, by an admin, with an embed token, or with valid signature parameters, and answers 404 to other callers, so a refusal keeps its existence undisclosed. An unknown table is 404 too.

A request that no capability authorized and that carried a credential which did not resolve is refused with 401 rather than served as an anonymous read, so an expired token is rejected instead of being silently downgraded. A request sending no credential is served normally.

cluster_radius is a screen-pixel distance, the same units MapLibre's clusterRadius uses, and cluster_max_zoom is the last zoom at which features are grouped. cols works as it does on the vector route, and the named columns are projected onto the unclustered features, so data-driven styling and popups keep working here too.

Requires a vector point dataset; another record type responds 400, as does a malformed table path or an out-of-range tile coordinate.

A tile holding no features answers 204, and a repeat request whose If-None-Match matches answers 304. Where a deployment runs cold storage, a dataset still being restored answers 202 with a job id to poll. Requests answer 429 with Retry-After when the per-process capacity for uncached renders is full, tile-pool acquisition times out, a tile query exceeds the pool's per-command timeout, or the configured per-tenant concurrency limit is exceeded. Any other failure serving the tile answers 503.

get/tiles/clusters/{table_path}/{z}/{x}/{y}.pbf

Request

  • The document declares no server URL.
  • Auth: one of:
    • none
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

table_pathstring required
zinteger required
xinteger required
yinteger required

Query parameters

sigstring nullable
expinteger nullable
scopestring nullable
colsstring nullable
cluster_radiusinteger
cluster_max_zoominteger

Response

The vector tile

Changes