API REFERENCE

getAuditLog

Reads audit records as an array, optionally filtered by type, sequence, or time. Returns an empty array when recording is disabled.

What does this API do?

Reads audit records as an array, optionally filtered by type, sequence, or time. Returns an empty array when recording is disabled.

Exact input and result types

typescript
getAuditLog(filter?: AuditLogFilter): Promise<AuditEntry[]>
ArgumentsRequiredType
filterOptionalAuditLogFilter

The return type is Promise<AuditEntry[]>.

Usage flow

After registering and initializing the Grid element, call grid.getAuditLog(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

Feature explanations and examples