Settings API - Apdex configuration for XHR actions schema table

Apdex configuration for XHR actions (builtin:rum.web.key-performance-metric-xhr-actions)

Select a key performance metric and set the Tolerating and Frustrated performance thresholds to refine the Apdex calculations for this application.

Schema ID
Schema groups
Scope
builtin:rum.web.key-performance-metric-xhr-actions
  • group:rum-kpm-settings
  • group:rum-settings
APPLICATION_METHOD - User Action
APPLICATION - Web application
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.key-performance-metric-xhr-actions
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.key-performance-metric-xhr-actions
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.key-performance-metric-xhr-actions

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
Key performance metric
kpm
enum
  • USER_ACTION_DURATION
  • VISUALLY_COMPLETE
  • RESPONSE_END
  • RESPONSE_START
required
Key performance metric thresholds
thresholds

Set the Tolerating and Frustrated performance thresholds for this action type.

required
Fallback metric thresholds
fallbackThresholds

If the selected key performance metric is not detected, the User action duration metric is used instead.

required
The Thresholds object
Property
Type
Description
Required
Tolerating threshold
toleratedThresholdSeconds
float

If the key performance metric is below this value, the action is assigned to the Satisfied performance zone.

required
Frustrated threshold
frustratingThresholdSeconds
float

If the key performance metric is above this value, the action is assigned to the Frustrated performance zone.

required
The FallbackThresholds object
Property
Type
Description
Required
Tolerating threshold [sec]
toleratedFallbackThresholdSeconds
float

If User action duration is below this value, the action is assigned to the Satisfied performance zone.

required
Frustrated threshold [sec]
frustratingFallbackThresholdSeconds
float

If User action duration is above this value, the action is assigned to the Frustrated performance zone.

required