Settings API - Enablement and cost control schema table

  • Published Dec 05, 2023

Enablement and cost control (builtin:rum.web.enablement)

Turn on Real User Monitoring and Session Replay. Configure cost and traffic control settings.

Schema IDSchema groupsScope
builtin:rum.web.enablement
  • group:web-and-mobile-monitoring.web-applications
  • group:web-and-mobile-monitoring
  • group:rum-settings
APPLICATION - Web application
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.enablement
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.enablement
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.enablement

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
Real User Monitoring
rum		rum

Capture and analyze all user actions within your application. Enable Real User Monitoring (RUM) to monitor and improve your application's performance, identify errors, and gain insight into your user's behavior and experience.

required
Session Replay
sessionReplay		sessionReplay

Session Replay captures all user interactions within your application and replays them in a movie-like experience while providing best-in-class security and data protection.

required
Experience Analytics
experienceAnalytics		experienceAnalytics-optional
The rum object
PropertyTypeDescriptionRequired
Enable Real User Monitoring Classic
enabled		boolean-required
Enable New Real User Monitoring Experience
enabledOnGrail		boolean-optional
Cost and traffic control
costAndTrafficControl		integer

Percentage of user sessions captured and analyzed

required
The sessionReplay object
PropertyTypeDescriptionRequired
Enable Session Replay Classic
enabled		boolean

Before enabling, Dynatrace checks your system against the prerequisites for Session Replay Classic.

required
Cost and traffic control
costAndTrafficControl		integer

Percentage of user sessions recorded with Session Replay Classic. For example, if you have 50% for RUM and 50% for Session Replay Classic, it results in 25% of sessions recorded with Session Replay Classic.

required
The experienceAnalytics object
PropertyTypeDescriptionRequired
Enable Experience Analytics
enabled		boolean

As part of the new RUM experience preview, Experience Analytics captures all interactions within your application. Check our documentation for more details: https://docs.dynatrace.com/docs/whats-new/preview-releases

required