Check a measure against itself
Where the same measure is published for both small areas and large ones, adding the small ones up should reproduce the large ones. This runs that check and shows the two figures side by side, so you can see where they disagree and by how much.
/measures/{measure-id}/reconciliationGood to know
- Both numbers come from the publisher. A difference is a clue about the crosswalk, the boundary vintage or the data itself, and nothing here is corrected.
- An area marked
incompleteis one where some of its smaller parts have no value, so the sum was always going to fall short. That is a gap, not a disagreement. - It is also how weightings are judged: the same constituencies added into local authorities land a median 0.3% from the published figures by population weight, and 8.8% by area weight.
- Leave
crosswalkout to see which comparisons are possible for this measure.
measure-idstringrequiredA measure id from
GET /v1/measures, such aspopulation, or one of itsaliases, such ashouse-prices. An alias is read as the id it names, and the response'sContent-Locationheader gives the request it was read as. Case, spaces and punctuation are set aside, soHouse Pricesishouse-prices.
crosswalkstringoptionalThe published crosswalk to add the finer partition up through.
pathstringoptionalA relationship path id from
GET /relationshipsto add the finer partition up through, in place ofcrosswalk.periodstringoptionalRequired with
crosswalkorpath; the period both partitions are compared for.
Returns
EnvelopeThe two figures side by side, or the comparisons available.
apiVersionv1requiredatlasReleasestringrequiredThe immutable
/atlas-releasereleaseIdfor the artifacts that produced this response.metaobjectrequiredShowHide1 child field
nextCursorstring | nullrequiredOpaque cursor for the next page, or null at the end.
- 400A query parameter is malformed or its cursor is not valid for this result set.
- 404No resource matches that identity.
- 422The named crosswalk cannot carry the comparison.
- 503The referenced build artifact has not been built yet.
Every error has the same shape. See Errors for how to handle them.
Show the precise behaviourHide the precise behaviour
Where the same measure is published on a fine geography and a coarse one, adding the fine one up through a published crosswalk should reproduce the coarse one. Both figures are the publisher's, so a difference is evidence: about the crosswalk, the boundary vintage or the data. Nothing is corrected; the two are reported side by side.
Each area is agrees within the published tolerance, differs beyond it, or incomplete where the finer partition has no value for some of the areas the crosswalk puts in this one, which is a gap rather than a disagreement. pairing is verified where the compatibility inventory has assessed each partition against the release its end of the crosswalk uses, and by-codes where the pairing rests on the codes the crosswalk carries.
A published relationship path may be named with path in place of crosswalk, adding the finer partition up through every one of its steps; the response then carries path, listing each step's crosswalk and direction, instead of crosswalk. Naming both is refused.
Without crosswalk or path, the comparisons this measure's partitions allow are listed rather than one being chosen. Published paths are listed more narrowly than crosswalks, since there are far more of them: a path of several steps is listed only between releases the measure's partitions are verified to join, and only where it reconciles the latest shared period, so a listed href does not answer with a refusal. At most one path is listed for each pair of releases and purpose, the best-ranked of the first few tried. This is how a weighting is judged: the same constituencies added into local authorities are a median 0.3% from the published figures by population weight and 8.8% by area weight.