UK Data AtlasAPI

List downloads

See every complete dataset you can download in one go, with its size, how many records it holds and a hash to check it arrived intact.

get
/exports

Returns

ExportManifestEnvelope

The bulk-export manifest.

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

  • dataExportManifestrequired
    Show7 child fields
    • schemaVersion1required
    • contentHashstringrequired
    • dataCatalogHashstringrequired
    • fieldsobjectrequired

      What each record field means.

    • datasetsobjectrequired
    • exportsBulkExport[]required
      Show14 child fields
      • idstringrequired
      • measureIdstringrequired
      • datasetIdstringrequired
      • periodsstring[]required
      • sourceGeographyobjectrequired
        Show2 child fields
        • typestringrequired
        • boundaryYearintegerrequired
      • formatjsonrequired
      • artifactstringrequired
      • contentHashstringrequired
      • bytesintegerrequired
      • hrefstringrequired
      • recordCountintegerrequired

        Records in the artifact, counted from it.

      • recordCountByPeriodobjectrequired
      • schemaobjectrequired

        The artifact's shape, read from the artifact. version is the artifact's schemaVersion, which increments when a field is removed, renamed or changes type or meaning, or the layout changes.

        Show5 child fields
        • versionintegerrequired
        • layoutenumrequired

          table is an artifact several measures share, such as a census table: one row per area, the area code and then a value for each measure in measures order, null where none is published. Each of its measures exports the whole table.

          One ofperiodssingle-periodtable
        • measuresstring[]optional

          For a table, the measure each value column serves, in order.

        • recordTypeenumrequired
          One ofnumericcategorical
        • fieldsExportField[]required
      • provenanceobjectrequired
        Show2 child fields
        • measurestringrequired
        • datasetsobject[]required

          Each id is described in the manifest's datasets.

    • notestringoptional

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

Returns immutable JSON downloads for each published measure-source partition, under the Atlas release that pins the manifest. Every entry names the artifact, its content hash and byte size, and describes it as read from the artifact at build time: its record counts, layout, record fields and the datasets to attribute. Field meanings and dataset attribution are listed once in fields and datasets.