Filters - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product

Data_Integrity

Spatial_Analytics

Data_Enrichment

geo_addressing_1

Services

Spatial Analytics

Data Enrichment

Geo Addressing

ft:title

Data Integrity Suite APIs

ft:locale

en-US

PublicationType

pt_developer

copyrightfirst

2023

copyrightlast

2026

Filters define the conditions used to select audit records. Each filter consists of:

field - the audit field to evaluate
operator - the comparison to apply
value - the value to compare against

Filters can be combined using AND / OR and may be nested.

filters (required)

Type: Filter

Defines the logical conditions used to select audit records. Filters support:

Field-based comparisons
Logical grouping using AND / OR
Nested expressions

A filter can be either:

A single condition, or
A filter group combining multiple conditions using logical operators

At least one filter condition is required.

Supported filter structure

Single condition

field: The audit log field to evaluate (e.g. year, what.category)
operator: The comparison operator
value: The value or values to compare against

Filter group

and: An array of two or more filter expressions that must all evaluate to true
or: An array of two or more filter expressions where any may evaluate to true

Filters may be nested to form complex logical expressions.

Operators

Operator	Description
eq	Equal to
neq	Not equal to
lt	Less than
lte	Less than or equal to
gt	Greater than
gte	Greater than or equal to
in	Value is in a list
nin	Value is not in a list

Value types

The value may be a string, integer, or an array of strings or integers, depending on the operator.

string
integer
Array of string or integer (for in / nin)

Supported fields

Filter conditions MUST reference only these audit fields:

Field	Description	Type
year	Four‑digit calendar year when the audited event occurred (UTC or system-defined timezone).	Temporal
Month	Numeric month (1–12) indicating when the event occurred within the specified year.	Temporal
day	Day of the month (1–31) on which the event occurred.	Temporal
outcome	The result of the audited action. Common values include: Success – action completed as intended Failure – action failed to a deviation of the system's external behavior from its expected or specified behavior Error – action unexpected in the system
who.type	The type of actor that initiated the action. Examples: User Service Agent Workflow Helps distinguish between human and non-human actors.
what.category	High‑level classification of the action being performed. Examples: Authentication Authorization Identify Used for reporting, filtering, and regulatory categorization.
what.description	Human‑readable explanation of the action that occurred (e.g., "User updated role assignments"). Intended to improve audit log readability for reviewers and auditors.
what.verb	The action verb representing what operation was performed. Examples: GET DELETE POST PUT JWTValidation AccessRequest
what.target.type	The type of resource that the action was performed on. Examples: API Workflow Agent
what.target.id	Unique identifier of the target resource affected by the action.
where.endpoint	The logical or physical endpoint through which the action was executed. Examples: REST API path (/v1/tenants/{id}) Service or component name UI module identifier Used for tracing access patterns and diagnosing failures.
correlators.traceid	Distributed tracing identifier that links this audit record to related operations across services or components. Enables end‑to‑end traceability in microservice and event‑driven architectures.
correlators.requestid	Unique identifier for the specific request that triggered the action. Typically scoped to a single API call or user interaction and used for debugging and support investigations.