Try it free

Settings API - Segment Configuration schema table

  • Published Jun 22, 2026

Saved Segments (app:my.user.session.analytics:segment-config)

Named audience segments for filtering Session Analytics. Each segment compiles to a DQL filter clause applied globally.

Schema IDSchema groupsScope
app:my.user.session.analytics:segment-config-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.user.session.analytics:segment-config
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:my.user.session.analytics:segment-config
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.user.session.analytics:segment-config

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
Segment Name
name		text

A short descriptive label (e.g. 'Italian mobile users')

Required
Sessions with errors only
hasErrors		boolean-Required
Bounced sessions only
isBounced		boolean-Required
Sessions with replay only
hasReplay		boolean-Required
Country ISO code
country		text

2-letter ISO code, e.g. IT, US, DE. Leave empty to ignore.

Required
Browser name (contains)
browser		text

e.g. Chrome, Firefox, Safari. Leave empty to ignore.

Required
OS name (contains)
os		text

e.g. Windows, macOS, Android. Leave empty to ignore.

Required
URL value
url		text

Value to match against the URL field selected in urlField. Leave empty to ignore.

Required
URL operator
urlOp		text

How to match: contains | not_contains | equals

Required
URL field
urlField		text

Which URL part to filter: path | domain | full

Required