Try it free

Settings API - Event correlation rule schema table

  • Published Sep 28, 2026

Event correlation rule (builtin:event-correlation-rules)

Allows you to define rules for correlating events.

Schema IDSchema groupsScope
builtin:event-correlation-rules-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:event-correlation-rules
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:event-correlation-rules
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:event-correlation-rules

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Display name
displayName		text

Name of the rule

Required
Enabled
enabled		boolean

If this is true, the rule is used when correlating events

Required
Source type
sourceType		enum

Where the rule comes from. Extension-provided and built-in rules are maintained by their source.

The element has these enums
  • USER
  • EXTENSION
  • BUILTIN
Optional
Source
source		text

Name of the source that provides the rule.

Optional
Time window
timeWindow		text

Other events within this time window are considered for correlation.

Required
Grouping fields
groupingFields		set

Fields used to group events. Groups are created based on the values of the grouping fields.

Required
Matching condition
matchingCondition		text

Matching condition to check if an event matches the correlation rule.

Required
Correlation namespace
correlationNamespace		text

Optional namespace for cross-rule correlation. Rules sharing the same namespace produce compatible grouping keys, enabling events matched by different rules to correlate to the same problem.

Optional
Causality rules
causalityRules		CausalityRule[]

Defines which correlated events cause which other events.

Required
The CausalityRule object
PropertyTypeDescriptionRequired
Cause event matcher
causeEventMatcher		text

Matching condition selecting the events that cause the effect events.

Required
Effect event matcher
effectEventMatcher		text

Matching condition selecting the events caused by the cause events.

Required