AuditLog
The audit log captures data related to usage activity routed through Quintessence by users. The AuditLog() function retrieves records and relevant details for all requests made to Quintessence within a specified date range.
Syntax:
Qx.AuditLog(AuditType, Start DateTime, End DateTime, View, Application, User)- In Excel with Quintessence addin versions prior to 25.1, use:
AuditLog() - In the Quintessence Editor (Studio) using Quintessence language, use:
AuditLog() - In the Quintessence Editor (Studio) using Python language, use:
Qx.AuditLog()
ⓘ See parameter descriptions
| AuditType | Specifies the type of audit data to retrieve. Options are: • function – Returns entries for each function used. • source – Returns the sources for which information was requested. |
| Start DateTime | The start date for the range. |
| End DateTime | The end date for the range. |
| View (optional) | Defines how the data should be displayed. Options include: • Dataview(*):column – Returns all columns with headers. To exclude headers, omit :column.• Dataview(Function, Application, User) – Returns only the specified columns. |
| Application (optional) | Filters results by application, e.g., Excel, Studio, or WebAPI. |
| User (optional) | Filters results by user. The domain username must be used. |
Remarks:
- To retrieve audit data with
AuditType = "source", a custom source must be configured to enable logging. - Audit records are stored on an hourly basis and are tied to the specified Start and End DateTime values. For example, to retrieve all audit records for August 11, 2023, set
Start DateTimeto 2023-08-11 andEnd DateTimeto 2023-08-12. - Audit records are updated at the top of each hour. For instance, if a Report() call is made at 10:15 AM, the corresponding audit record will only be available after 11:00 AM.
Examples:
The examples provided below are based on fictitious data for illustrative purposes only.
> Example 1: Retrieve audit of logged functions
Return all functions executed by all users on August 8, 2025. The data should display the function, the user, the application and the hour in which the function was executed.
=Qx.AuditLog("Function", "8 August 2025", "9 August 2025", "Dataview(Function, User, Time):column")| Function | User | Application | Time |
| TimeSeries | QuintTest\LinH | Web API | 11:00 AM |
| Report | QuintTest\LinH | Excel | 1:00 PM |
| TimeSeries | QuintTest\AlbA | Excel | 1:00 PM |
> Example 2: Retrieve audit of logged sources called by a specific user via Excel
Return all sources (already configured for audit logging) that were accessed by the user QuintTest\LinH via Excel on August 8, 2025. The data should display the source and the application context (which workbook and worksheet the source was called from).
=Qx.AuditLog("Source", "8 August 2025", "9 August 2025", "Dataview(Source, ApplicationContext):column", "Excel", "QuintTest\LinH")| Source | Application Context |
| Quintessence Source | {“Workbook”:”{new}”,”Worksheet”:”Sheet1″} |