• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Opt-out banner

Settings API - Opt-out banner schema table

Opt-out banner (builtin:ua.opt-out)

Configure opt out banner to gather feedback about your page.

Schema IDSchema groupsScope
builtin:ua.opt-out
  • group:unified-analysis
ua-screen
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.opt-out
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:ua.opt-out
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:ua.opt-out

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

PropertyLabelTypeDescriptionRequired
feedbackUrlFeedback URL - SeaOtter IDtext

The ID of SeaOtter entry that is an URL to feedback form. Leave empty to use default.

optional
displayOptOutDisplay opt-out switchboolean

When true, the switch to go back to old screen will be visible.

required
userVariableOpt-out user variabletext

The user variable key for opt-out switch. Leave empty to generate.

optional