Function: getAuditRecords()

function getAuditRecords(client, parameters?): Promise<{
[key: string]: unknown;
  _links: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  limit: number;
  results: object[];
  size: number;
  start: number;
}>;

Defined in: src/v1/api/audit.ts:18

Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator's guide.

Permissions required: 'Confluence Administrator' global permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ endDate?: string; limit?: number; searchString?: string; start?: number; startDate?: string; }	-
parameters.endDate?	string	Filters the results to the records on or before the endDate. The endDate must be specified as epoch time in milliseconds.
parameters.limit?	number	The maximum number of records to return per page. Note, this may be restricted by fixed system limits.
parameters.searchString?	string	Filters the results to records that have string property values matching the searchString.
parameters.start?	number	The starting index of the returned records.
parameters.startDate?	string	Filters the results to the records on or after the startDate. The startDate must be specified as epoch time in milliseconds.

Returns

Promise<{ [key: string]: unknown; _links: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; limit: number; results: object[]; size: number; start: number; }>