audit

Export activity log feed

Returns the activity log as a feed suitable for a log collector or SIEM tool. Unlike the regular activity log listing, results are returned oldest first, so a collector can page forward from a saved position without missing or re-reading events. Returns newline-delimited JSON by default; pass ?format=json for a human-readable array. Use the from and to parameters for a half-open time window, and the x-brix-next-cursor and x-brix-has-more response headers to page through results.

Notes.

  • Oldest first. The default body is NDJSON: one AuditEvent object per line. The next-page cursor is in the X-Brix-Next-Cursor header (empty on the last page) and X-Brix-Has-More is 1 or 0.
  • With format=json the body is JSON: { data: AuditEvent[], nextCursor: string | null }.
get/v1/audit/export

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/audit/export
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (default 500, max 1000).

cursorstring

The X-Brix-Next-Cursor header (or nextCursor) of the previous page.

fromstring

ISO-8601; events at or after this time.

tostring

ISO-8601; events before this time.

format'json'

json answers { data: AuditEvent[], nextCursor } instead of NDJSON.

Response

Success. The body is the file itself.

Changes

No recorded changes to this operation across all 1 revision of this API.