Try it free

Settings API - Conversion Configuration schema table

  • Published Jun 22, 2026

Conversion Configuration (app:my.user.session.analytics:conversion-config)

Configure conversion page patterns per Frontend application. Only users with app-settings write permissions can modify these settings.

Schema IDSchema groupsScope
app:my.user.session.analytics:conversion-config-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.user.session.analytics:conversion-config
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:my.user.session.analytics:conversion-config
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:my.user.session.analytics:conversion-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
Configuration Name
name
text

A label for this conversion configuration (e.g. 'Sizzling Pubs Conversions')

Required
Frontend Application ID
applicationId
text

The dt.entity.rum_application entity ID this config applies to (e.g. APPLICATION-ABC123)

Required
Conversion Page Patterns
conversionPatterns
list

URL path keywords that indicate a conversion (e.g. 'checkout', 'payment', 'thank-you'). A session visiting any page containing one of these patterns counts as converted.

Required