---
title: "system.util.queryAuditLog"
description: "Queries an audit profile for audit history."
---

# system.util.queryAuditLog

> Queries an audit profile for audit history.

This function is used in **Python Scripting**.

## Description
Queries an audit profile for audit history. Returns the results as a dataset.

A description of the returned dataset can be found on the [Ignition Database Table Reference](../../reference-pages/ignition-database-table-reference/ignition-database-table-reference.md#audit-log) page. 

## Client Permission Restrictions
This scripting function has no [Client Permission](../../../ignition-modules/vision/vision-project-properties/vision-project-properties.md#vision-permissions-properties) restrictions.

## Syntax - Gateway Scope
`system.util.queryAuditLog(auditProfileName, [startDate], [endDate], [actorFilter], [actionFilter], [targetFilter], [valueFilter], [systemFilter], [contextFilter])`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String| `auditProfileName` | The name of the audit profile to pull the history from.
Date| `startDate` | The earliest audit event to return. If omitted, the current time - 8 hours will be used. [optional]
Date| `endDate` | The latest audit event to return. If omitted, the current time will be used. [optional]
String| `actorFilter` | A filter string used to restrict the results by actor. [optional]
String| `actionFilter` | A filter string used to restrict the results by action. [optional]
String| `targetFilter` | A filter string used to restrict the results by target. [optional]
String| `valueFilter` | A filter string used to restrict the results by value. [optional]
String| `systemFilter` | A filter string used to restrict the results by system. [optional]
Integer| `contextFilter` | A bitmask used to restrict the results by context. 0x01 = Gateway, 0x02 = Designer, 0x04 = Client. [optional]

### Returns
**Dataset** - A dataset with the audit events from the specified profile that match the filter arguments.

### Scope
Gateway

## Syntax - Perspective Session and Vision Client Scope
`system.util.queryAuditLog([auditProfileName], [startDate], [endDate], [actorFilter], [actionFilter], [targetFilter], [valueFilter], [systemFilter], [contextFilter])`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String| `auditProfileName` | The name of the audit profile to pull the history from. [optional] **Note:** The project must have an Audit Profile configured in Project Properties. Otherwise this parameter is mandatory.
Date| `startDate` | The earliest audit event to return. If omitted, the current time - 8 hours will be used. [optional]
Date| `endDate` | The latest audit event to return. If omitted, the current time will be used. [optional]
String| `actorFilter` | A filter string used to restrict the results by actor. [optional]
String| `actionFilter` | A filter string used to restrict the results by action. [optional]
String| `targetFilter` | A filter string used to restrict the results by target. [optional]
String| `valueFilter` | A filter string used to restrict the results by value. [optional]
String| `systemFilter` | A filter string used to restrict the results by system. [optional]
Integer| `contextFilter` | A bitmask used to restrict the results by context. 0x01 = Gateway, 0x02 = Designer, 0x04 = Client. [optional]

### Returns
**Dataset** - A dataset with the audit events from the specified profile that match the filter arguments.

### Scope
Perspective Session, Vision Client

## Code Examples
```python title="Example #1"
# This script queries an audit log, checks to see if a user john made any tag writes in the last 8 hours
# (since the startDate parameter is omitted), and writes the results to a table.
data = system.util.queryAuditLog(auditProfileName='AuditLog', actorFilter='john', actionFilter='tag write')
  
event.source.parent.getComponent("Table").data = data
```