Export the filtered audit events as CSV

get

https://api.qfp.quantnetwork.net/api/audit/events/export

Streams every event matching the same filters the list accepts, as CSV,
with the header row eventId,occurredAt,action,category,source,actorType,actorId,requestId,resourceType,resourceId,outcome,summary,changedFields.

Not pageable: an export is always the whole filtered set, newest
first, with no upper bound on rows. Columns are exactly the list's
(field names for data changes, no values); multiple changed field
names share one space-separated cell, and actorId carries no
display name.

Cells are quoted (inner quotes doubled), values starting with =,
+, -, @, a tab or a carriage return are prefixed with a visible
apostrophe so spreadsheets treat them as text, rows end CRLF, and the
response is UTF-8 with
Content-Disposition: attachment; filename="audit-events.csv".

Query Params

occurredFrom

date-time

Inclusive lower bound on occurredAt, the producer's clock at emit rather than the time the event was recorded. ISO 8601, or the legacy yyyy-MM-dd HH:mm:ss.SSS form.

occurredTo

date-time

Inclusive upper bound on occurredAt. Must not be earlier than occurredFrom, which is a 400 rather than a silently empty page.

actorIds

array of strings

Match any of these actor ids. Repeat the parameter (?actorIds=a&actorIds=b) or give it once comma-separated (?actorIds=a,b). Matching is exact.

actorIds

requestId

string

length ≤ 128

Exact match on the correlation id of the originating request, for following one request across the platform. Events emitted by unattended work carry none.

action

string

length ≤ 50

Exact match on the verb, e.g. CREATE, UPDATE, DELETE, READ, LOGIN, LOGIN_FAILED, APPROVED. The list is open, so an unrecognised value is not an error; it simply matches nothing.

source

string

length ≤ 100

Exact match on the component that emitted the event.

resourceType

string

length ≤ 100

Exact match on the kind of thing the event was about.

resourceId

string

length ≤ 128

Exact match on one instance, giving the history of a single record. Events that name no single instance, such as a login, carry none.

query

string

length ≤ 128

Case-insensitive prefix search across identifier fields only (requestId, resource.id and actor.id), plus an exact match on the event id when the value parses as a whole UUID. It never searches the event payload. A fragment from the middle of an identifier does not match.

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/csv

application/json

200The matching events as CSV, streamed. A filter that matches nothing still returns the header row.

400A filter the service will not accept: an inverted occurredAt range, a query longer than 128 characters, or a date that does not parse. Reported before any row is written.

401The bearer token is missing, unparsable, or lacks the sub or tenant_id claim.