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 ID	Schema groups	Scope
`builtin:rum.web.custom-errors`	`group:rum-errors`	`APPLICATION` - Web application `environment-default`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.custom-errors`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.custom-errors`
	Environment ActiveGate	`https://{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

Property	Label	Type	Description	Required
ignoreCustomErrorsInApdexCalculation	Ignore custom errors in Apdex calculations	boolean	This setting overrides Apdex settings for individual rules listed below	required
errorRules	-	list	-	required

Request body objects

The `CaptureSettings` object

Property	Label	Type	Description	Required
capture	Capture this error	boolean	-	required
impactApdex	Include error in Apdex calculations	boolean	-	required
considerForAi	Include error in Davis AI problem detection and analysis	boolean	View more details	required

The `CustomErrorRule` object

Property	Label	Type	Description	Required
keyMatcher	Match key	enum	-	required
keyPattern	Key pattern	text	A case-insensitive key pattern	required
valueMatcher	Match value	enum	-	required
valuePattern	Value pattern	text	A case-insensitive value pattern	required
captureSettings	Capture settings	CaptureSettings	-	required