Try it free

Preview an event trigger filter

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Deprecated

Preview an event trigger filter in Dynatrace with the Automation API by sending triggerConfiguration and checking the resulting filter behavior.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/automation/v1/event-triggers/filter-preview

Overview

You send a triggerConfiguration object in the request body to preview the filter. Dynatrace returns the preview result for the event trigger filter through the Automation API.

Authentication

To execute this request, you need a platform token or OAuth access token with automation:workflows:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyEventTriggerPreviewRequest-bodyRequired

Request body objects

The EventTriggerPreviewRequest object

ElementTypeDescriptionRequired
triggerConfigurationEventQueryTriggerConfig | DavisProblemTriggerConfig | DavisEventTriggerConfig-Required

The EventTriggerConfig object

The EventQueryTriggerConfig object

Config for generic event triggers ("Event trigger"). No dedup — fires on every matching event.

ElementTypeDescriptionRequired
typeEventQueryTriggerConfigType-
The element can hold these values
  • event
Required
valueEventQuery-Required

The DavisProblemTriggerConfig object

Config for Problem event triggers ("Problem trigger").

Deduplicated across a problem's lifecycle: fires once per phase selected by the trigger config (triggerOn, triggerOnUpdateFields), not on every update.

ElementTypeDescriptionRequired
typeDavisProblemTriggerConfigType-
The element can hold these values
  • davis-problem
Required
valueDavisProblemConfig-Required

The DavisEventTriggerConfig object

Config for Davis Event event triggers ("Davis event trigger").

Deduplicated across an event's lifecycle: fires once per phase selected by the trigger config (triggerOn), not on every update.

ElementTypeDescriptionRequired
typeDavisEventTriggerConfigType-
The element can hold these values
  • davis-event
Required
valueDavisEventConfig-Required

The EventQueryTriggerConfigType object

The EventQuery object

ElementTypeDescriptionRequired
querystring

DQL matcher expression defining which events to match.

Required
eventTypeEventType

Grail event type.

The element can hold these values
  • events
  • bizevents
  • dt.system.events
  • security.events
Optional

The EventType object

Grail event type.

The DavisProblemTriggerConfigType object

The DavisProblemConfig object

ElementTypeDescriptionRequired
entityTagsMatchEntityTagsMatch-Optional
entityTagsEntityTags-Optional
onProblemCloseboolean

DEPRECATED

Trigger on Davis problem open only or also on close. Deprecated — use triggerOn instead.

Optional
triggerOnTriggerOn

Problem state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.

Optional
categoriesDavisProblemCategories-Required
customFilterstring

Additional DQL matcher expression to further filter events to match.

Optional
analysisReadyboolean

Run only after first root cause analysis run completed.

Optional
severityThresholdinteger

Triggers only for problems whose severity is this value or more severe. Lower numbers are more severe (1 = critical, 5 = informational), so 3 matches severities 1, 2, and 3.

Optional
triggerOnUpdateFieldsTriggerOnUpdateFields[]

Problem event fields tracked for value changes. Changes to any selected field cause re-triggering.

Optional
problemOpenDurationinteger

Minimum problem duration in minutes before the trigger fires.

The element can hold these values
  • 5
  • 10
  • 15
  • 30
  • 60
  • 120
  • 240
  • 1440
  • 10080
Optional

The EntityTagsMatch object

Event must match all or any of the entity tags.

The EntityTags object

Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}

The TriggerOn object

The DavisProblemCategories object

ElementTypeDescriptionRequired
monitoringUnavailableboolean-Optional
availabilityboolean-Optional
errorboolean-Optional
slowdownboolean-Optional
resourceboolean-Optional
customboolean-Optional
infoboolean-Optional

The TriggerOnUpdateFields object

The DavisEventTriggerConfigType object

The DavisEventConfig object

ElementTypeDescriptionRequired
entityTagsMatchEntityTagsMatch-Optional
entityTagsEntityTags-Optional
onProblemCloseboolean

DEPRECATED

Trigger on Davis event open only or also on close. Deprecated — use triggerOn instead.

Optional
triggerOnTriggerOn

Event state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.

Optional
namesDavisEventName[]-Optional
typesstring[]

DEPRECATED

-		Optional
customFilterstring

Additional DQL matcher expression to further filter events to match.

Optional
maintenanceWindowTriggerBehaviorMaintenanceWindowTriggerBehaviorType-Optional

The DavisEventName object

ElementTypeDescriptionRequired
matchDavisEventNameMatch

Davis event name must equal or contain the string provided.

The element can hold these values
  • equals
  • contains
Required
namestring-Required

The DavisEventNameMatch object

Davis event name must equal or contain the string provided.

The MaintenanceWindowTriggerBehaviorType object

Specifies when to trigger based on maintenance window status.

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "triggerConfiguration": {
    "type": "event",
    "value": {
      "eventType": "bizevents",
      "query": "event.kind == \"CUSTOM_KIND\""
    }
  }
}

Response

Response codes

CodeTypeDescription
200EventTriggerPreviewResponse-
4XXErrorEnvelope-

Response body objects

The EventTriggerPreviewResponse object

ElementTypeDescription
triggerConfigurationEventQueryTriggerConfig | DavisProblemTriggerConfig | DavisEventTriggerConfig-
filterQuerystring-

The EventTriggerConfig object

The EventQueryTriggerConfig object

Config for generic event triggers ("Event trigger"). No dedup — fires on every matching event.

ElementTypeDescription
typeEventQueryTriggerConfigType-
The element can hold these values
  • event
valueEventQuery-

The DavisProblemTriggerConfig object

Config for Problem event triggers ("Problem trigger").

Deduplicated across a problem's lifecycle: fires once per phase selected by the trigger config (triggerOn, triggerOnUpdateFields), not on every update.

ElementTypeDescription
typeDavisProblemTriggerConfigType-
The element can hold these values
  • davis-problem
valueDavisProblemConfig-

The DavisEventTriggerConfig object

Config for Davis Event event triggers ("Davis event trigger").

Deduplicated across an event's lifecycle: fires once per phase selected by the trigger config (triggerOn), not on every update.

ElementTypeDescription
typeDavisEventTriggerConfigType-
The element can hold these values
  • davis-event
valueDavisEventConfig-

The EventQueryTriggerConfigType object

The EventQuery object

ElementTypeDescription
querystring

DQL matcher expression defining which events to match.

eventTypeEventType

Grail event type.

The element can hold these values
  • events
  • bizevents
  • dt.system.events
  • security.events

The EventType object

Grail event type.

The DavisProblemTriggerConfigType object

The DavisProblemConfig object

ElementTypeDescription
entityTagsMatchEntityTagsMatch-
entityTagsEntityTags-
onProblemCloseboolean

DEPRECATED

Trigger on Davis problem open only or also on close. Deprecated — use triggerOn instead.

triggerOnTriggerOn

Problem state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.

categoriesDavisProblemCategories-
customFilterstring

Additional DQL matcher expression to further filter events to match.

analysisReadyboolean

Run only after first root cause analysis run completed.

severityThresholdinteger

Triggers only for problems whose severity is this value or more severe. Lower numbers are more severe (1 = critical, 5 = informational), so 3 matches severities 1, 2, and 3.

triggerOnUpdateFieldsTriggerOnUpdateFields[]

Problem event fields tracked for value changes. Changes to any selected field cause re-triggering.

problemOpenDurationinteger

Minimum problem duration in minutes before the trigger fires.

The element can hold these values
  • 5
  • 10
  • 15
  • 30
  • 60
  • 120
  • 240
  • 1440
  • 10080

The EntityTagsMatch object

Event must match all or any of the entity tags.

The EntityTags object

Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}

The TriggerOn object

The DavisProblemCategories object

ElementTypeDescription
monitoringUnavailableboolean-
availabilityboolean-
errorboolean-
slowdownboolean-
resourceboolean-
customboolean-
infoboolean-

The TriggerOnUpdateFields object

The DavisEventTriggerConfigType object

The DavisEventConfig object

ElementTypeDescription
entityTagsMatchEntityTagsMatch-
entityTagsEntityTags-
onProblemCloseboolean

DEPRECATED

Trigger on Davis event open only or also on close. Deprecated — use triggerOn instead.

triggerOnTriggerOn

Event state to trigger on. "open" (active only), "open-and-close" (both phases), or "close" (closure only). When unset, falls back to onProblemClose for backward compatibility.

namesDavisEventName[]-
typesstring[]

DEPRECATED

-
customFilterstring

Additional DQL matcher expression to further filter events to match.

maintenanceWindowTriggerBehaviorMaintenanceWindowTriggerBehaviorType-

The DavisEventName object

ElementTypeDescription
matchDavisEventNameMatch

Davis event name must equal or contain the string provided.

The element can hold these values
  • equals
  • contains
namestring-

The DavisEventNameMatch object

Davis event name must equal or contain the string provided.

The MaintenanceWindowTriggerBehaviorType object

Specifies when to trigger based on maintenance window status.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
messagestring-
codeinteger-
detailsErrorDetails-

The ErrorDetails object

ElementTypeDescription
errorCodestring-
errorRefstring-

Response body JSON models

{
  "triggerConfiguration": {
    "type": "event",
    "value": {
      "eventType": "bizevents",
      "query": "event.kind == \"CUSTOM_KIND\""
    }
  },
  "filterQuery": "string"
}
{
  "error": {
    "message": "string",
    "code": 1,
    "details": {
      "errorCode": "string",
      "errorRef": "string"
    }
  }
}
Related tags
Platform APIDynatrace Platform