Settings API - Enablement and cost control schema table

  • Published Dec 05, 2023

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

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

Schema IDSchema groupsScope
builtin:rum.mobile.enablement
  • group:rum-general
  • group:web-and-mobile-monitoring
MOBILE_APPLICATION - Mobile App
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.mobile.enablement
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.mobile.enablement
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.mobile.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
The rum object
PropertyTypeDescriptionRequired
Enable Real User Monitoring Classic
enabled		boolean-required
Enable New Real User Monitoring Experience
enabledOnGrail		boolean

Please be aware that only mobile agents with version 8.309 or higher can ingest Grail events

optional
Cost and traffic control
costAndTrafficControl		integer

Percentage of user sessions captured and analyzed

By default, Dynatrace captures all user actions and user sessions for analysis. This approach ensures complete insight into your application’s performance and customer experience. You can optionally reduce the granularity of user-action and user-session analysis by capturing a lower percentage of user sessions. While this approach can reduce monitoring costs, it also results in lower visibility into how your customers are using your applications. For example, a setting of 10% results in Dynatrace analyzing only every tenth user session.

required
The sessionReplay object
PropertyTypeDescriptionRequired
Enable Session Replay Classic on crashes
onCrash		boolean

Capture screen recordings that replay the user actions preceding all detected crashes. Before enabling, Dynatrace checks your system against the prerequisites for Session Replay.

required