Settings API - User experience score schema table
User experience score (builtin:rum.user-experience-score)
A user experience score is calculated for each user session. Scores reflect the overall performance, usability, and detected errors of each session. Experiences are classified as either Satisfying, Tolerable, or Frustrating.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:rum.user-experience-score |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.user-experience-score |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.user-experience-score | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.user-experience-score |
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 | Type | Description | Required |
---|---|---|---|
If last user action in a session is classified as Frustrating, classify the entire session as FrustratingconsiderLastAction | boolean | - | required |
Consider rage clicks / rage taps in score calculationconsiderRageClick | boolean | - | required |
Threshold for Frustrating user experiencemaxFrustratedUserActionsThreshold | integer | User experience is considered Frustrating when the selected percentage or more of the user actions in a session are rated as Frustrating. | required |
Threshold for Satisfying user experienceminSatisfiedUserActionsThreshold | integer | User experience is considered Satisfying when at least the selected percentage of the user actions in a session are rated as Satisfying. | required |