UK Data AtlasAPI

List reviewed conversions

See which measure, source and analysis-boundary combinations the Atlas has reviewed as safe to convert. A crosswalk appearing in the catalogue alone is not an approval to use it for analysis.

get
/analysis-geographies

Good to know

  • Add measure to narrow the list to the conversions available for one measure.
  • Each entry names the source partition and the crosswalk, so you can inspect exactly what will be regrouped.

Query parameters

  • measurestringoptional

Returns

AnalysisGeographyListEnvelope

Reviewed analysis geography support.

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

  • dataobjectrequired
    Show1 child field
    • analysisGeographiesobject[]required
      Show7 child fields
      • geographystringrequired
      • boundaryReleasestringrequired
      • measureIdstringrequired
      • sourceAnalysisSourcerequired
        Show4 child fields
        • datasetIdstringrequired
        • geographystringrequired
        • boundaryYearintegerrequired
        • periodsstring[]required
      • basisderivedrequired
      • conversionAnalysisCrosswalk | objectrequired

        The reviewed crosswalk, or the published path whose steps the conversion runs through.

      • notestringrequired

When it goes wrong

  • 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

Lists the measure/source/frame conversions that the Atlas has reviewed as safe to perform. A published crosswalk alone is not sufficient. A reviewed conversion is one crosswalk, or a published relationship path whose conversion.method is relationship-path and whose conversion.steps list each crosswalk and direction it runs through.