Check a measure's coverage

See where a measure has data, and what share of its area codes appear in each boundary release.

get

https://api.ukdataatlas.com/v1/measures/{measure-id}/coverage

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

geographystringoptional
With release, the geography of a boundary release to assess the measure against.
releasestringoptional
With geography, the boundary release to assess the measure against.

Returns

Envelope

Source coverage and boundary code-coverage summary.

apiVersionv1required
atlasReleasestringrequired
The immutable /atlas-release releaseId for the artifacts that produced this response.
metaobjectrequired
ShowHide1 child field
- nextCursorstring | nullrequired
  Opaque cursor for the next page, or null at the end.

When it goes wrong

400Only one of geography and release is given.
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.

Summarises each source partition's published coverage and the proportion of its area codes found in every assessed boundary release. An eligible code join means all source codes are present; it does not assert equal geometry or perform a geographic conversion.

Given geography and release together, target answers whether the measure can be had on that boundary release, in the capability vocabulary: available from a partition whose codes all join a release with no area left without a value, partial when some areas have none or the codes only partly join, requires-conversion with the conversions a published crosswalk makes possible, as on an area's capabilities, and unsupported otherwise, always with a reason.