UK Data AtlasAPI

Plan coverage by country

Before you rank or map a measure across the UK, check what it actually covers. Ward population, for instance, is published for England and Wales and for neither Scotland nor Northern Ireland, so a ranking of UK wards would quietly leave two countries out. This tells you that first.

get
/measures/{measure-id}/coverage-plan

Good to know

  • Each country comes back as source-exact, converted, partial or missing, with the number of areas behind it.
  • A missing country says whether the measure exists elsewhere and only lacks a route onto this release, which tells you what would fix it.
  • Counts come from the areas a source or conversion really carries, and nothing is estimated to fill a gap.

Path parameters

  • 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

  • geographystringrequired

    The geography of the boundary release to plan against.

  • releasestringrequired

    The boundary release to plan against.

Returns

Envelope

The measure's coverage of one release, country by country.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 404No resource matches that identity.
  • 503The referenced build artifact has not been built yet.

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

Technical notes

Show the precise behaviour

A release-wide answer is one word for the whole of it, which hides the shape of a gap: ward population is published for England and Wales and for neither Scotland nor Northern Ireland, so a ranking of United Kingdom wards silently leaves two countries out. This answers each country on its own.

A country is source-exact when a partition published on the release carries a value for every area of it there, converted when a published crosswalk the convert route accepts reaches them all, partial when either reaches some, and missing when neither reaches any. The counts come from the areas a source or conversion actually carries, not from declared coverage, and a missing country says whether the measure exists elsewhere and only lacks a route onto this release. No value is estimated to fill a gap.