API REFERENCE

getAuditLogAsJson

Reads audit records as a structured JSON array string. Use pretty for readable indentation.

What does this API do?

Reads audit records as a structured JSON array string. Use pretty for readable indentation.

Exact input and result types

typescript
getAuditLogAsJson(filter?: AuditLogFilter, pretty?: boolean): Promise<string>
ArgumentsRequiredType
filterOptionalAuditLogFilter
prettyOptionalboolean

The return type is Promise<string>.

Usage flow

After registering and initializing the Grid element, call grid.getAuditLogAsJson(…). 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