UK Data AtlasAPI

Get checks for a measure

See the checks that one measure's definition is consistent, both with itself and with the rest of the catalogue.

get
/validation/measures/{measure-id}

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

ValidationResourceEnvelope

The measure's checks.

  • 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.

  • dataValidationResourcerequired
    Show4 child fields
    • idstringrequired

      atlas for checks across the Atlas's own artifacts; otherwise the validated resource's API path, such as crosswalks/{crosswalk-id}. A measure source partition is identified by the export that serves it, as exports/{export-id}.

    • kindenumrequired
      One ofatlasboundary-releasecrosswalkmeasuremeasure-source
    • statusenumrequired

      waived when any of its checks is waived.

      One ofpassedwaived
    • checksValidationCheck[]required
      Show5 child fields
      • idenumrequired
        One ofregistry-linksrelease-coveragelicence-recordedarea-identitiesgeometry-servablegeometry-positionedcandidates-reviewedartifact-integrityendpoints-verifiedsource-names-consistenttargets-presentsingle-parentweights-sum-to-onearea-coveragesliver-separationcontinuity-extentpopulation-coveragecontainment-verifiedbest-fit-verifiedmeasure-definitionrecords-resolvecountries-declaredvalues-validcomponents-sum-to-total
      • statusenumrequired
        One ofpassedwaived
      • detailstringoptional

        What the check found. Present on every waived check.

      • measuredobjectoptional

        Figures the check measured, whether it passed or not.

      • waiverobjectoptional
        Show1 child field
        • reasonstringrequired

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

Checks that a measure's definition agrees with itself and with the catalogue: its availability matches its aggregation, a categorical value has categorical aggregation, every dataset it names exists, an export serves each of its sources, and a weighted mean has a summable weight measure on the same geography and periods. Each source partition's own checks are served under /validation/exports/{export-id}.