• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Custom errors

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
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
ignoreCustomErrorsInApdexCalculationIgnore custom errors in Apdex calculationsboolean

This setting overrides Apdex settings for individual rules listed below

required
errorRules-list-required

Request body objects

The CaptureSettings object
PropertyLabelTypeDescriptionRequired
captureCapture this errorboolean-required
impactApdexInclude error in Apdex calculationsboolean-required
considerForAiInclude error in Davis AI problem detection and analysisboolean

View more details

required
The CustomErrorRule object
PropertyLabelTypeDescriptionRequired
keyMatcherMatch keyenum-required
keyPatternKey patterntext

A case-insensitive key pattern

required
valueMatcherMatch valueenum-required
valuePatternValue patterntext

A case-insensitive value pattern

required
captureSettingsCapture settingsCaptureSettings-required