UK Data AtlasAPI

Check a measure's quality

A pre-flight check before you request data: every source and period, how its records were produced, whether it can be aggregated and which boundaries it fits.

get
/measures/{measure-id}/quality

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

The measure-quality matrix.

  • 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

Reports every source partition and period before a data request, including source record-status counts, immutable artifact hash, aggregation availability and boundary code-set compatibility. It does not infer missing areas or claim geometric equivalence from code sets.