UK Data AtlasAPI

Check which boundaries fit

Find out which boundary releases a measure's data can be drawn on, by checking that every area code it uses is present.

get
/measures/{measure-id}/compatibility

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.

Returns

Envelope

Compatibility counts and bounded samples of unmatched source and candidate-only codes.

  • 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

  • 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

Compares every source partition's area-code set with compiled boundary releases of the same geography and source boundary year. A code-set-compatible result means every source code occurs in the candidate; it does not select that release or assert identical geometry.