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 |
| APPLICATION - Web applicationenvironment-default |
| 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 | Type | Description | Required |
|---|---|---|---|
Ignore custom errors in Apdex calculationsignoreCustomErrorsInApdexCalculation | boolean | This setting overrides Apdex settings for individual rules listed below | required |
errorRules | CustomErrorRule[] | - | required |
The CustomErrorRule object
| Property | Type | Description | Required |
|---|---|---|---|
Match keykeyMatcher | enum |
| required |
Key patternkeyPattern | text | A case-insensitive key pattern | required |
Match valuevalueMatcher | enum |
| required |
Value patternvaluePattern | text | A case-insensitive value pattern | required |
Capture settingscaptureSettings | CaptureSettings | - | required |
The CaptureSettings object
| Property | Type | Description | Required |
|---|---|---|---|
Capture this errorcapture | boolean | - | required |
Include error in Apdex calculationsimpactApdex | boolean | - | required |
Include error in Davis AI problem detection and analysisconsiderForAi | boolean | required |