Interface: ListAuditOptions

@kortexya/reasoninglayer / Compliance / ListAuditOptions

Interface: ListAuditOptions

Defined in: src/types/compliance.ts:101

Options for GET /api/v1/compliance/audit/list — a paged, sorted, filterable read over the tenant’s append-only audit ledger.

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

all?

optional all: boolean

Defined in: src/types/compliance.ts:117

Return the full filtered set (export use case), bypassing the bounded limit / offset window.

limit?

optional limit: number

Defined in: src/types/compliance.ts:113

Page size, clamped to 1..=200 by the backend; defaults to 50. Ignored when all is set.

offset?

optional offset: number

Defined in: src/types/compliance.ts:115

Zero-based offset within the sorted, filtered set. Ignored when all is set.

requestPathPattern?

optional requestPathPattern: string

Defined in: src/types/compliance.ts:103

Glob matched against requestPath (e.g. /api/v1/oversight/**); omit to match all paths.

since?

optional since: string

Defined in: src/types/compliance.ts:105

Inclusive lower bound on timestamp (RFC 3339, e.g. 2026-01-01T00:00:00Z).

sortBy?

optional sortBy: AuditSortField

Defined in: src/types/compliance.ts:109

Sort field. Defaults to timestamp on the backend.

sortOrder?

optional sortOrder: AuditSortOrder

Defined in: src/types/compliance.ts:111

Sort direction. Defaults to desc (most-recent-first) on the backend.

until?

optional until: string

Defined in: src/types/compliance.ts:107

Inclusive upper bound on timestamp (RFC 3339).