Audit Log

Export the audit log as CSV.

Changed on

Returns the audit log for a range of whole days as CSV, most recent first. from and to are dates (YYYY-MM-DD), both inclusive, read in zone (an IANA time zone such as UTC or America/New_York), or in the server's time zone when zone is omitted. to may be at most 30 days after from. Returns up to limit events (default 100, at most 1000; a larger value is treated as the maximum, and zero or less as the default). The X-Philter-Export-Truncated header is true when more remain, and X-Philter-Export-Next-Cursor then gives the cursor to request the next page with. Events are ordered by timestamp and then id, and a cursor continues after the last event of its page, so paging by cursor returns each event exactly once even while events are being written, including each page's own audit event. offset, with X-Philter-Export-Next-Offset, is kept for paging a range that is no longer receiving events; on a range that includes the current day it can repeat events across pages. Give offset or cursor, not both. Timestamps in the CSV are UTC. The export is itself audited. Requires an administrator as well as the audit:read scope. Requires the audit:read scope.

get/api/audit/export

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/audit/export
  • Auth
    HTTP bearer

Query parameters

fromstring
tostring
zonestring
offsetinteger
cursorstring
limitinteger

Headers

Authorizationstring required

Response

The CSV. Headers give the row count, whether it was truncated, and the time zone used.

Changes

    • breaking

      the response's body type changed from object to string for status

    • breaking

      for the query request parameter offset, default value 0 was removed

    • info

      added the new optional query request parameter cursor