UK Data AtlasAPI

Get the validation report

Every check the build ran on boundaries, crosswalks and measures. Nothing is published with an unexplained failure: each accepted exception is listed with the reason it was accepted.

get
/validation

Good to know

  • Filter by result with status.

Query parameters

  • statusstringoptional

    Return only resources with this status.

    One ofpassedwaived
  • scopestringoptional

    Return only the served source-observation quality audit, with a summary recalculated for those resources.

    One ofdata

Returns

ValidationReportEnvelope

The validation report for the current Atlas release.

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

  • dataValidationReportrequired
    Show5 child fields
    • schemaVersion1required
    • contentHashstringrequired
    • inputsobjectrequired

      Content hashes of the artifacts and waivers the checks read.

    • summaryobjectrequired
      Show5 child fields
      • resourceCountintegerrequired
      • checkCountintegerrequired
      • passedCountintegerrequired
      • waivedCountintegerrequired
      • coverageobjectrequired

        How many boundary releases each capability reaches. servableGeometry counts releases with servable geometry for at least some areas; their geometry-servable checks name any areas refused. measures and measureSources count the checked measures and their source partitions.

        Show8 child fields
        • boundaryReleasesintegerrequired
        • areaIdentitiesintegerrequired
        • servableGeometryintegerrequired
        • withRelationshipsintegerrequired
        • crosswalksintegerrequired
        • weightedCrosswalksintegerrequired
        • measuresintegerrequired
        • measureSourcesintegerrequired
    • resourcesValidationResource[]required
      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

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 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

The build checks each boundary release, each crosswalk, each measure, each measure's source partitions and the links between the Atlas's own artifacts, recomputing what it can from the published artifacts rather than trusting each compiler's claims. A check either passes or is waived: the build fails on any exception without a recorded reason, and on any waiver that no longer matches an exception. Waived checks carry what was found and why it was accepted. Use scope=data for the source-observation quality audit: artifact hashes and record counts, duplicate area-period records, area-code resolution, country coverage, numeric semantics and publisher-supplied interval bounds. It does not rewrite the source observations it checks.