OFoffice-of-national-statistics
Private

List the audit events for bundles.

Changed on

Audit log of bundle changes and views.

get/bundle-events

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

bundlestring

The bundle ID to filter the bundle to return events for.

afterstring date-time

The date from which to query bundle events

beforestring date-time

The date to which to query bundle 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 the bundle.

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": "/bundles/e58e8381-c6b2-4e5a-934c-8cbce9b4dc6f/contents/31fda76c-972e-4f73-a999-f9fc428ba74f",
      "data": {
        "dataset_id": "cpih",
        "edition_id": "march-2025",
        "item_id": "de3bc0b6-d6c4-4e20-917e-95d7ea8c91dc",
        "state": "published",
        "url_path": "/datasets/cpih/editions/march-2025/versions/1"
      }
    }
  ]
}

Changes

  • 39ab0233bf90Revision changes
    • warning

      deleted the query request parameter after_filter

    • warning

      deleted the query request parameter before_filter

    • info

      added the new optional query request parameter after

    • info

      added the new optional query request parameter before

  • ef2686afc3f9Revision changes
    • warning

      deleted the path request parameter id

    • info

      added the new optional query request parameter bundle

    • info

      added the non-success response with the status