v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-23111218.0 KB
Get list of file access events

Audit log of file access events.

get/file-events

Query parameters

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.

afterstring date-time

The date from which to query file access events.

beforestring date-time

The date to which to query file access events.

pathstring

The file path on which to query file access events.

Response

The list of file access events.

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"
      },
      "action": "READ",
      "resource": "/downloads-new/dataset-upload/myfile.csv",
      "file": {
        "path": "images/meme.jpg",
        "is_publishable": true,
        "collection_id": "1234-asdfg-54321-qwerty",
        "bundle_id": "bundle-789-xyz",
        "title": "The latest Meme",
        "size_in_bytes": 14794,
        "type": "image/jpeg",
        "licence": "OGL v3",
        "licence_url": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "etag": "1234567890asdfghjk",
        "state": "UPLOADED",
        "content_item": {
          "dataset_id": "cpih01",
          "edition": "time-series",
          "version": "1"
        }
      }
    }
  ]
}
All 11 operations