Settings API - Enablement and cost control schema table
Enablement and cost control (builtin:rum.mobile.enablement)
Turn on Real User Monitoring and Session Replay. Configure cost and traffic control settings.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:rum.mobile.enablement |
| MOBILE_APPLICATION - Mobile Appenvironment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.mobile.enablement |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.mobile.enablement | |
| Environment ActiveGate | https://{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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| rum | Real User Monitoring | 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 |
| sessionReplay | Session Replay on crashes | sessionReplay | Session Replay on crashes gives you additional context for crash analysis in the form of video-like screen recordings that replay user actions immediately preceding a detected crash, while providing best-in-class security and data protection. | required |
Request body objects
The rum object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enable Real User Monitoring | boolean | - | required |
| costAndTrafficControl | Cost and traffic control | 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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| onCrash | Enable Session Replay on crashes | boolean | Before enabling, Dynatrace checks your system against the prerequisites for Session Replay. | required |