Settings API - Request errors schema table

  • Published Dec 05, 2023

Request errors (builtin:rum.web.request-errors)

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

Schema IDSchema groupsScope
builtin:rum.web.request-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.request-errors
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.request-errors
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.request-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 request errors in Apdex calculations
ignoreRequestErrorsInApdexCalculation		boolean

This setting overrides Apdex settings for individual rules listed below

Required
errorRulesRequestErrorRule[]-Required
The RequestErrorRule object
PropertyTypeDescriptionRequired
Match by error code
errorCodes		text-Optional
Match by errors that have failed image requests
considerFailedImages		boolean-Required
Match by errors that have CSP violations
considerCspViolations		boolean-Required
Filter settings
filterSettings		FilterSettings-Required
Capture settings
captureSettings		CaptureSettings-Required
The FilterSettings object
PropertyTypeDescriptionRequired
Filter by URL
filter		enum
The element has these enums
  • BEGINS_WITH
  • ENDS_WITH
  • CONTAINS
  • EQUALS
Optional
URL
url		text-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