Get a dataset

Get one source dataset's details: its publisher, its source files and their hashes.

get

https://api.ukdataatlas.com/v1/datasets/{dataset-id}

Path parameters

dataset-idstringrequired
A dataset id from GET /v1/datasets, such as population-uk.

Returns

Envelope

Dataset metadata and source lineage.

apiVersionv1required
atlasReleasestringrequired
The immutable /atlas-release releaseId for the artifacts that produced this response.
metaobjectrequired
ShowHide1 child field
- nextCursorstring | nullrequired
  Opaque cursor for the next page, or null at the end.

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.

Request

curl "https://api.ukdataatlas.com/v1/datasets/population-uk"

Response200

{
  "apiVersion": "v1",
  "atlasRelease": "sha256:5c4aa4529cbfbd5e4c844c55cddba1ef04a7bf76f3eaa085a357fff401af6d0c",
  "data": {
    "id": "population-uk",
    "label": "Population (Local Authority)",
    "publisher": "Office for National Statistics",
    "sourceUrl": "https://www.ons.gov.uk/peoplepopulationandcommunity/populationandmigration/populationestimates/datasets/populationestimatesforukenglandandwalesscotlandandnorthernireland",
    "temporalCoverage": "2011-2024",
    "licence": {
      "name": "Open Government Licence v3.0",
      "url": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
    },
    "description": "UK local authority population estimates by single year of age and sex, mid-2011 to mid-2024.",
    "inputs": [
      {
        "kind": "xlsxSheet",
        "path": "demographics/population/mid-year-estimates/uk/myebtablesuk20112024.xlsx#MYEB1",
        "bytes": 5951518,
        "sha256": "aec8a5343f3f71ee062cc5b0e3f137087f89e1a1ccd0725cc6ffd2c77ba5d0f1"
      }
    ],
    "summary": {
      "datasetCount": 14,
      "dataRecordCount": 5054,
      "boundaryYears": [
        2023
      ]
    },
    "compiled": {
      "bytes": 13350128,
      "sha256": "9dae35e958883344f25f6c3c1b2730a8ae88881ce375c2b85b5c9c2fcd213d1e"
    }
  },
  "meta": {
    "nextCursor": null
  }
}