v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-14355492.7 KB
Private

List all events relating to a dataset, edition, or version for static datasets only.

Returns a list of events for a dataset, edition, or version for static datasets only.

get/dataset-events

Query parameters

idstring

ID that represents a dataset

editionstring

An edition of a dataset to search on

afterstring date-time

The date from which to query dataset events

beforestring date-time

The date to which to query dataset events

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

The list of change audit events for a dataset or edition.

countinteger

The number of items returned.

limitinteger

The number of items requested.

offsetinteger

The offset of the first item to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

total_countinteger

The total number of items available.

Example response

{
  "count": 20,
  "total_count": 123,
  "items": [
    {
      "requested_by": {
        "id": "0889d599-3f0e-4564-9d6e-9455a6b73da7",
        "email": "publisher@ons.gov.uk"
      },
      "resource": "/datasets/cpi/editions/march/versions/1",
      "data": {
        "edition": "march",
        "edition_title": "March 2025",
        "release_date": "2026-07-14T16:12:55.617Z",
        "state": "published",
        "last_updated": "2026-07-14T16:12:55.617Z",
        "version": 1,
        "type": "static",
        "e_tag": "ae798cd1893778920d74e1bb185b215fce309708",
        "quality_designation": "accredited-official",
        "links": {
          "dataset": {
            "href": "/datasets/cpi",
            "id": "cpi"
          },
          "edition": {
            "href": "/datasets/cpi/editions/march",
            "id": "march"
          },
          "self": {
            "href": "/datasets/cpi/editions/march/versions/1"
          },
          "version": {
            "href": "/datasets/cpi/editions/march/versions/1,",
            "id": 1
          }
        },
        "distributions": [
          {
            "title": "Full Dataset (CSV)",
            "format": "csv",
            "media_type": "text/csv",
            "download_url": "/datasets/RM086/editions/march/thedownloadfile.csv",
            "byte_size": 4300000
          }
        ]
      }
    }
  ]
}