Interface: ListAuditOptions
@kortexya/reasoninglayer / ListAuditOptions
Interface: ListAuditOptions
Section titled “Interface: ListAuditOptions”Defined in: src/types/compliance.ts:109
Options for GET /api/v1/compliance/audit/list — a paged, sorted,
filterable read over the tenant’s append-only audit ledger.
Remarks
Section titled “Remarks”The backend applies a bounded default page size (50, clamped to
1..=200) when limit is omitted and all is not set. Pass
all: true to request the full filtered set (the export use case),
which bypasses the bounded limit / offset window; the response
then reports limit: null. offset is zero-based and ignored when
all is set. total in the returned AuditPage reflects the
filtered set, not the raw tenant count.
Properties
Section titled “Properties”actor?
Section titled “actor?”
optionalactor?:string
Defined in: src/types/compliance.ts:118
Exact actor selection: a user id (UUID) selects that user’s records; the
literal 'system' selects the records with no actor — the same key
SummaryResponse.perActor uses. Any other value is refused with
400. Omit for every actor.
optionalall?:boolean
Defined in: src/types/compliance.ts:139
Return the full filtered set (export use case), bypassing the bounded limit / offset window.
limit?
Section titled “limit?”
optionallimit?:number
Defined in: src/types/compliance.ts:135
Page size, clamped to 1..=200 by the backend; defaults to 50. Ignored when all is set.
offset?
Section titled “offset?”
optionaloffset?:number
Defined in: src/types/compliance.ts:137
Zero-based offset within the sorted, filtered set. Ignored when all is set.
optionalq?:string
Defined in: src/types/compliance.ts:125
Case-insensitive substring searched in each record’s requestPath, its
actor id, and every scalar value inside extra (nested values included;
object keys, hashes and record ids are not searched). Omit for no text
constraint.
requestPathPattern?
Section titled “requestPathPattern?”
optionalrequestPathPattern?:string
Defined in: src/types/compliance.ts:111
Glob matched against requestPath (e.g. /api/v1/oversight/**); omit to match all paths.
since?
Section titled “since?”
optionalsince?:string
Defined in: src/types/compliance.ts:127
Inclusive lower bound on timestamp (RFC 3339, e.g. 2026-01-01T00:00:00Z).
sortBy?
Section titled “sortBy?”
optionalsortBy?:AuditSortField
Defined in: src/types/compliance.ts:131
Sort field. Defaults to timestamp on the backend.
sortOrder?
Section titled “sortOrder?”
optionalsortOrder?:AuditSortOrder
Defined in: src/types/compliance.ts:133
Sort direction. Defaults to desc (most-recent-first) on the backend.
until?
Section titled “until?”
optionaluntil?:string
Defined in: src/types/compliance.ts:129
Inclusive upper bound on timestamp (RFC 3339).