Settings API - UA DQL filtering schema table

  • Published Sep 25, 2025

UA DQL filtering (builtin:ua.dql-filtering)

Configure DQL filtering.

Schema IDSchema groupsScope
builtin:ua.dql-filtering
  • group:unified-analysis
ua-explorer
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.dql-filtering
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.dql-filtering
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.dql-filtering

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
Key
key		text

Filtering key used that can be referenced in Inventory Explorer types config.

required
Filters
filters		FilterDefinition[]

List of filters.

required
The FilterDefinition object
PropertyTypeDescriptionRequired
Filter label
label		text

Name of the filter which is shown in the UI.

required
Query
query		text

DQL fragment that should be inserted after "filter" command. Following variables are available in this field: $value (from value suggestion), $key (optionally from key-value suggestions) and $field (field-reference).

required
Field
field		text

Reference to a field from main query or lookup, the field that should be filtered.

required
Default filter
defaultFilter		boolean

Specifies if a the filter is suggested as complete statement, when typing values into the filter field without selecting a key first.

required
Distinct filter
distinctFilter		boolean

Specifies if the filter is suggested again, once selected

required
Field IDs
valueSuggestion		ValueSuggestion

Datasource of autosuggestion.

required
The ValueSuggestion object
PropertyTypeDescriptionRequired
typeenum
  • STATIC
  • DYNAMIC
required
Value extractor
valueExtractor		text

Required for filter where value needs to be extracted from a field. It is also needed if other fields than $value is required (like $key)

optional
Value formatter
valueFormatter		text

When the suggestion doesn't provide a display name, a formatter can be used to produce a name based on value.

optional
Predefined filter values
values		PredefinedFilterValue[]

If the suggestion doesn't provide display name and name can be produced based on value

required
The PredefinedFilterValue object
PropertyTypeDescriptionRequired
Text
text		text

Required for filter where value needs to be extracted from a field, it is also needed if other fields than $value is required (like $key).

required
Value
value		text

Value that should be included in main query - Eq. "DE", to fit into "country == $value" query.

optional
Query
query		text

Query for each value, if specified it overrides the main query. Eg. "problems > 0".

optional