UK Data AtlasAPI

Get checks for a download

See the checks run on one downloadable dataset: that it matches its hash, every area code resolves, it covers the right countries and its values make sense.

get
/validation/exports/{export-id}

Path parameters

  • export-idstringrequired

    An export id from GET /v1/exports; one source partition of one measure.

Returns

ValidationResourceEnvelope

The source partition'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

Each export serves one source partition of a measure, and is checked from the observation artifact itself. artifact-integrity: the content reproduces its hash, which matches the export manifest, and its measure, geography, periods, latest-period record count and unique area codes match the catalogue. records-resolve: one compiled boundary release of the source geography and boundary year holds every area code, in every period. countries-declared: the codes cover exactly the nations the catalogue declares. values-valid: every record suits its measure, such as whole, non-negative counts, percentages from 0 to 100, deciles from 1 to 10 and published intervals that contain their value. A measure declared as the sum of others adds components-sum-to-total, comparing each area and period with its components in the same source partitions.