Settings API - Custom errors schema table

Custom errors (builtin:rum.web.custom-errors)

Create rules to capture custom errors and include them in your Apdex calculations or Davis AI problem detection and analysis. For more details, see Configure custom errors.

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

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
Ignore custom errors in Apdex calculations
ignoreCustomErrorsInApdexCalculation		boolean

This setting overrides Apdex settings for individual rules listed below

required
errorRulesCustomErrorRule[]-required
The CustomErrorRule object
PropertyTypeDescriptionRequired
Match key
keyMatcher		enum
  • ALL
  • BEGINS_WITH
  • ENDS_WITH
  • CONTAINS
  • EQUALS
required
Key pattern
keyPattern		text

A case-insensitive key pattern

required
Match value
valueMatcher		enum
  • ALL
  • BEGINS_WITH
  • ENDS_WITH
  • CONTAINS
  • EQUALS
required
Value pattern
valuePattern		text

A case-insensitive value pattern

required
Capture settings
captureSettings		CaptureSettings-required
The CaptureSettings object
PropertyTypeDescriptionRequired
Capture this error
capture		boolean-required
Include error in Apdex calculations
impactApdex		boolean-required
Include error in Davis AI problem detection and analysis
considerForAi		boolean

View more details

required