Get values for tiles

A small table of one measure's values, keyed by the same numeric id the tiles use, so your map can colour areas without touching the shapes.

get

https://api.ukdataatlas.com/v1/map-resources/{geography}/{release}/join/{measure-id}

Good to know

If the measure's area codes aren't all in this boundary release, you'll get an incompatible_geometry refusal that names releases that would work.
Add format=parquet for the same table as a Parquet file, to join to the GeoParquet shapes in a warehouse.

Path parameters

geographystringrequired
A geography type id, e.g. constituency or ward.
releasestringrequired
A boundary release id, e.g. 2024-07-uk-bgc, or latest for the geography's newest release: the one /boundary-releases:resolve chooses for the furthest date. A response to latest names the release it read in Content-Location. A geography whose newest month holds several releases that differ in more than coverage, or that has a release whose id carries no month, is refused with 409 and the releases that could be newest.
measure-idstringrequired
A measure id from GET /v1/measures, such as population, or one of its aliases, such as house-prices. An alias is read as the id it names, and the response's Content-Location header gives the request it was read as. Case, spaces and punctuation are set aside, so House Prices is house-prices.

Query parameters

periodstringrequired
The observation period the values describe.
geographystringoptional
The measure's source geography, where it publishes more than one partition. Without it an ambiguous request is refused with the partitions listed rather than one being chosen by catalogue order.
boundaryYearintegeroptional
The measure's source boundary year, alongside geography.
formatstringoptional
json for the envelope a renderer reads, parquet for the same rows as a Parquet file.
One ofjsonparquet
Defaultjson

Returns

string

The values, numbered as the tiles number their features.

When it goes wrong

400A query parameter is malformed or its cursor is not valid for this result set.
404No resource matches that identity.
422The measure's source codes are not all in this release, so its values cannot be drawn on it.
503The referenced build artifact has not been built yet.

Every error has the same shape. See Errors for how to handle them.

The values a renderer joins to the tiles, as id, code and value. The id is the same integer the tile carries, so a renderer sets feature state by it without reading the geometry. Values are joined to this release by matching area code and are never converted: a measure whose source codes are not all in this release is refused with incompatible_geometry, and the refusal names the releases that would carry it. Keeping values out of the tiles is what lets one tileset serve every measure, and lets a corrected value invalidate a small table rather than a whole pyramid.

With format=parquet the same table is served as a Parquet file with id, code, value and status columns, for a warehouse to join to the GeoParquet features. Everything the JSON envelope says about the table, from the Atlas release to the join rule and provenance, travels in the file's uk-data-atlas metadata.