List reviewed corrections

See the reviewed API-owned corrections, derived calculations and normalisations that can affect a response, with their exact scope and evidence.

get

https://api.ukdataatlas.com/v1/corrections

Good to know

The default data response remains source-exact; use the explicit request described by a correction to opt into a reviewed transformation.

Query parameters

measurestringoptional
Return records applying to this measure, including records scoped to every measure.

Returns

Envelope

Reviewed API-owned correction and transformation records.

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

400A query parameter is malformed or its cursor is not valid for this result set.

Every error has the same shape. See Errors for how to handle them.

The correction register records API-owned repairs, derived calculations and normalisations separately from the publisher's artifacts. Each record states its exact scope, source behaviour, served behaviour, evidence and review status. A correction never overwrites the raw source: a later revision supersedes its record, preserving the earlier explanation for audit. The first record covers the opt-in canonical-unit representation; default data responses remain source-exact.

Request

curl "https://api.ukdataatlas.com/v1/corrections?measure=ghg-emissions"

Response200

{
  "apiVersion": "v1",
  "atlasRelease": "sha256:5c4aa4529cbfbd5e4c844c55cddba1ef04a7bf76f3eaa085a357fff401af6d0c",
  "data": {
    "records": [
      {
        "id": "canonical-unit-presentation-v1",
        "kind": "normalisation",
        "status": "active",
        "title": "Opt-in canonical measure-unit presentation",
        "scope": {
          "measureIds": [
            "*"
          ],
          "fields": [
            "value",
            "confidenceInterval.lower",
            "confidenceInterval.upper"
          ],
          "request": "GET /v1/data/{measure-id}?units=canonical"
        },
        "change": {
          "source": "The default response preserves each publisher's value, label and interval bounds.",
          "served": "On the explicit canonical request, each numeric value and any publisher-supplied interval bound is multiplied by the measure's declared scale; the response names the resulting unit and calculation.",
          "sourceArtifactsChanged": false
        },
        "evidence": [
          {
            "kind": "method",
            "href": "/v1/measures",
            "note": "Every served measure declares its display unit and API-owned canonical unit definition."
          }
        ],
        "review": {
          "status": "reviewed",
          "note": "The transformation is opt-in, has a declared positive scale, and is refused for categorical observations."
        }
      }
    ],
    "filters": {
      "measure": "ghg-emissions"
    },
    "note": "These records describe API-owned changes to served values or semantics. They do not rewrite the publisher artifacts, which remain the source evidence."
  },
  "meta": {
    "nextCursor": null
  }
}

List reviewed corrections

Query parameters

Returns

When it goes wrong

Technical notes