Web application configuration API - PUT default application

Updates the default web application of your Dynatrace environment.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/default

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyWebApplicationConfig

JSON body of the request, containing the new parameters of the default web application.

bodyoptional

Request body objects

The WebApplicationConfig object

Configuration of a web application.

ElementTypeDescriptionRequired
conversionGoalsConversionGoal[]

A list of conversion goals of the application.

optional
costControlUserSessionPercentagenumber

Analize X% of user sessions.

required
customActionApdexSettingsApdex

Defines the Apdex settings of an application.

required
identifierstring

Dynatrace entity ID of the web application.

optional
loadActionApdexSettingsApdex

Defines the Apdex settings of an application.

required
loadActionKeyPerformanceMetricstring

The key performance metric of load actions.

  • ACTION_DURATION
  • CUMULATIVE_LAYOUT_SHIFT
  • DOM_INTERACTIVE
  • FIRST_INPUT_DELAY
  • LARGEST_CONTENTFUL_PAINT
  • LOAD_EVENT_END
  • LOAD_EVENT_START
  • RESPONSE_END
  • RESPONSE_START
  • SPEED_INDEX
  • VISUALLY_COMPLETE
required
metaDataCaptureSettingsMetaDataCapturing[]

Java script agent meta data capture settings.

optional
metadataConfigurationMetadata

Metadata useful for debugging

optional
monitoringSettingsMonitoringSettings

Real user monitoring settings.

required
namestring

The name of the web application, displayed in the UI.

required
realUserMonitoringEnabledboolean

Real user monitoring enabled/disabled.

required
sessionReplayConfigSessionReplaySetting

Session replay settings

optional
typestring

The type of the web application.

  • AUTO_INJECTED
  • BROWSER_EXTENSION_INJECTED
  • MANUALLY_INJECTED
optional
urlInjectionPatternstring

Url injection pattern for manual web application.

optional
userActionAndSessionPropertiesUserActionAndSessionProperties[]

User action and session properties settings. Empty List means no change

optional
userActionNamingSettingsUserActionNamingSettings

The settings of user action naming.

optional
userTagsUserTag[]

User tags settings.

optional
waterfallSettingsWaterfallSettings

These settings influence the monitoring data you receive for 3rd party, CDN, and 1st party resources.

required
xhrActionApdexSettingsApdex

Defines the Apdex settings of an application.

required
xhrActionKeyPerformanceMetricstring

The key performance metric of XHR actions.

  • ACTION_DURATION
  • RESPONSE_END
  • RESPONSE_START
  • VISUALLY_COMPLETE
required

The ConversionGoal object

A conversion goal of the application.

ElementTypeDescriptionRequired
destinationDetailsDestinationDetails

Configuration of a destination-based conversion goal.

optional
idstring

The ID of conversion goal.

Omit it while creating a new conversion goal.

optional
namestring

The name of the conversion goal.

required
typestring

The type of the conversion goal.

  • Destination
  • UserAction
  • VisitDuration
  • VisitNumActions
optional
userActionDetailsUserActionDetails

Configuration of a user action-based conversion goal.

optional
visitDurationDetailsVisitDurationDetails

Configuration of a visit duration-based conversion goal.

optional
visitNumActionDetailsVisitNumActionDetails

Configuration of a number of user actions-based conversion goal.

optional

The DestinationDetails object

Configuration of a destination-based conversion goal.

ElementTypeDescriptionRequired
caseSensitiveboolean

The match is case-sensitive (true) or (false).

optional
matchTypestring

The operator of the match.

  • Begins
  • Contains
  • Ends
optional
urlOrPathstring

The path to be reached to hit the conversion goal.

required

The UserActionDetails object

Configuration of a user action-based conversion goal.

ElementTypeDescriptionRequired
actionTypestring

Type of the action to which the rule applies.

  • Custom
  • Load
  • Xhr
optional
caseSensitiveboolean

The match is case-sensitive (true) or (false).

optional
matchEntitystring

The type of the entity to which the rule applies.

  • ActionName
  • PageUrl
optional
matchTypestring

The operator of the match.

  • Begins
  • Contains
  • Ends
optional
valuestring

The value to be matched to hit the conversion goal.

optional

The VisitDurationDetails object

Configuration of a visit duration-based conversion goal.

ElementTypeDescriptionRequired
durationInMillisinteger

The duration of session to hit the conversion goal, in milliseconds.

required

The VisitNumActionDetails object

Configuration of a number of user actions-based conversion goal.

ElementTypeDescriptionRequired
numUserActionsinteger

The number of user actions to hit the conversion goal.

optional

The Apdex object

Defines the Apdex settings of an application.

ElementTypeDescriptionRequired
frustratingFallbackThresholdnumber

Fallback threshold of an XHR action, defining a tolerable user experience, when the configured KPM is not available.

optional
frustratingThresholdnumber

Maximal value of apdex, which is considered as tolerable user experience.

optional
toleratedFallbackThresholdnumber

Fallback threshold of an XHR action, defining a satisfied user experience, when the configured KPM is not available.

optional
toleratedThresholdnumber

Maximal value of apdex, which is considered as satisfied user experience.

optional

The MetaDataCapturing object

Configuration to capture meta data with the Javascript agent. The captured metadata can be referenced by its uniqueId in UserTags, UserActionAndSessionProperties or UserActionNamingPlaceholder

ElementTypeDescriptionRequired
capturingNamestring

The name of the meta data to capture.

required
namestring

Name for displaying the captured values in Dynatrace.

required
publicMetadataboolean

True if this metadata should be captured regardless of the privacy settings

optional
typestring

The type of the meta data to capture.

  • COOKIE
  • CSS_SELECTOR
  • JAVA_SCRIPT_FUNCTION
  • JAVA_SCRIPT_VARIABLE
  • META_TAG
  • QUERY_STRING
  • RESPONSE_HEADER
required
uniqueIdinteger

The unique id of the meta data to capture.

optional
useLastValueboolean

True if the last captured value should be used for this metadata. By default the first value will be used.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
clusterVersionstring

Dynatrace version.

optional
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional

The MonitoringSettings object

Real user monitoring settings.

ElementTypeDescriptionRequired
addCrossOriginAnonymousAttributeboolean

Add the cross origin = anonymous attribute to capture JavaScript error messages and W3C resource timings.

optional
advancedJavaScriptTagSettingsAdvancedJavaScriptTagSettings

Advanced JavaScript tag settings.

required
angularPackageNamestring

The name of the angular package.

optional
browserRestrictionSettingsWebApplicationConfigBrowserRestrictionSettings

Settings for restricting certain browser type, version, platform and, comparator. It also restricts the mode.

optional
cacheControlHeaderOptimizationsboolean

Optimize the value of cache control headers for use with Dynatrace real user monitoring enabled/disabled.

required
contentCaptureContentCapture

Settings for content capture.

required
cookiePlacementDomainstring

Domain for cookie placement.

optional
correlationHeaderInclusionRegexstring

To enable RUM for XHR calls to AWS Lambda, define a regular expression matching these calls, Dynatrace can then automatically add a custom header (x-dtc) to each such request to the respective endpoints in AWS.

Important: These endpoints must accept the x-dtc header, or the requests will fail.

optional
customConfigurationPropertiesstring

Additional JavaScript tag properties that are specific to your application. To do this, type key=value pairs separated using a (|) symbol.

required
excludeXhrRegexstring

You can exclude some actions from becoming XHR actions.

Put a regular expression, matching all the required URLs, here.

If noting specified the feature is disabled.

required
fetchRequestsboolean

fetch() request capture enabled/disabled.

required
injectionModestring

JavaScript injection mode.

  • CODE_SNIPPET
  • CODE_SNIPPET_ASYNC
  • INLINE_CODE
  • JAVASCRIPT_TAG
  • JAVASCRIPT_TAG_COMPLETE
  • JAVASCRIPT_TAG_SRI
required
instrumentedWebServerboolean

Instrumented web or app server.

optional
ipAddressRestrictionSettingsWebApplicationConfigIpAddressRestrictionSettings

Settings for restricting certain ip addresses and for introducing subnet mask. It also restricts the mode.

optional
javaScriptFrameworkSupportJavaScriptFrameworkSupport

Support of various JavaScript frameworks.

required
javaScriptInjectionRulesJavaScriptInjectionRules[]

Java script injection rules.

optional
libraryFileFromCdnboolean

Get the JavaScript library file from the CDN.

Not supported by agentless applications and assumed to be false for auto-injected applications if omitted.

optional
libraryFileLocationstring

The location of your application’s custom JavaScript library file.

If nothing specified the root directory of your web server is used.

Required for auto-injected applications, not supported by agentless applications.

optional
monitoringDataPathstring

The location to send monitoring data from the JavaScript tag.

Specify either a relative or an absolute URL. If you use an absolute URL, data will be sent using CORS.

Required for auto-injected applications, optional for agentless applications.

optional
sameSiteCookieAttributestring

Same site cookie attribute

  • LAX
  • NONE
  • STRICT
optional
scriptTagCacheDurationInHoursinteger

Time duration for the cache settings.

optional
secureCookieAttributeboolean

Secure attribute usage for Dynatrace cookies enabled/disabled.

required
serverRequestPathIdstring

Path to identify the server’s request ID.

required
useCorsboolean

Send beacon data via CORS.

optional
xmlHttpRequestboolean

XmlHttpRequest support enabled/disabled.

required

The AdvancedJavaScriptTagSettings object

Advanced JavaScript tag settings.

ElementTypeDescriptionRequired
additionalEventHandlersAdditionalEventHandlers

Additional event handlers and wrappers.

required
eventWrapperSettingsEventWrapperSettings

In addition to the event handlers, events called using addEventListener or attachEvent can be captured. Be careful with this option! Event wrappers can conflict with the JavaScript code on a web page.

required
globalEventCaptureSettingsGlobalEventCaptureSettings

Global event capture settings.

required
instrumentUnsupportedAjaxFrameworksboolean

Instrumentation of unsupported Ajax frameworks enabled/disabled.

required
maxActionNameLengthinteger

Maximum character length for action names. Valid values range from 5 to 10000.

required
maxErrorsToCaptureinteger

Maximum number of errors to be captured per page. Valid values range from 0 to 50.

required
proxyWrapperEnabledboolean

Proxy wrapper enabled/disabled.

optional
specialCharactersToEscapestring

Additional special characters that are to be escaped using non-alphanumeric characters in HTML escape format.

required
syncBeaconFirefoxboolean

Send the beacon signal as a synchronous XMLHttpRequest using Firefox enabled/disabled.

optional
syncBeaconInternetExplorerboolean

Send the beacon signal as a synchronous XMLHttpRequest using Internet Explorer enabled/disabled.

optional
userActionNameAttributestring

User action name attribute.

optional

The AdditionalEventHandlers object

Additional event handlers and wrappers.

ElementTypeDescriptionRequired
blurEventHandlerboolean

Blur event handler enabled/disabled.

required
changeEventHandlerboolean

Change event handler enabled/disabled.

required
clickEventHandlerboolean

Click event handler enabled/disabled.

required
maxDomNodesToInstrumentinteger

Max. number of DOM nodes to instrument. Valid values range from 0 to 100000.

required
mouseupEventHandlerboolean

Mouseup event handler enabled/disabled.

required
toStringMethodboolean

toString method enabled/disabled.

required
userMouseupEventForClicksboolean

Use mouseup event for clicks enabled/disabled.

required

The EventWrapperSettings object

In addition to the event handlers, events called using addEventListener or attachEvent can be captured. Be careful with this option! Event wrappers can conflict with the JavaScript code on a web page.

ElementTypeDescriptionRequired
blurboolean

Blur enabled/disabled.

required
changeboolean

Change enabled/disabled.

required
clickboolean

Click enabled/disabled.

required
mouseUpboolean

MouseUp enabled/disabled.

required
touchEndboolean

TouchEnd enabled/disabled.

required
touchStartboolean

TouchStart enabled/disabled.

required

The GlobalEventCaptureSettings object

Global event capture settings.

ElementTypeDescriptionRequired
additionalEventCapturedAsUserInputstring

Additional events to be captured globally as user input.

For example, DragStart or DragEnd.

required
changeboolean

Change enabled/disabled.

optional
clickboolean

Click enabled/disabled.

required
doubleClickboolean

DoubleClick enabled/disabled.

required
keyDownboolean

KeyDown enabled/disabled.

required
keyUpboolean

KeyUp enabled/disabled.

required
mouseDownboolean

MouseDown enabled/disabled.

required
mouseUpboolean

MouseUp enabled/disabled.

required
scrollboolean

Scroll enabled/disabled.

required
touchEndboolean

TouchEnd enabled/disabled.

optional
touchStartboolean

TouchStart enabled/disabled.

optional

The WebApplicationConfigBrowserRestrictionSettings object

Settings for restricting certain browser type, version, platform and, comparator. It also restricts the mode.

ElementTypeDescriptionRequired
browserRestrictionsWebApplicationConfigBrowserRestriction[]

A list of browser restrictions.

optional
modestring

The mode of the list of browser restrictions.

  • EXCLUDE
  • INCLUDE
required

The WebApplicationConfigBrowserRestriction object

Browser exclusion rules for the browsers that are to be excluded.

ElementTypeDescriptionRequired
browserTypestring

The type of the browser that is used.

  • ANDROID_WEBKIT
  • BOTS_SPIDERS
  • CHROME
  • CHROME_HEADLESS
  • EDGE
  • FIREFOX
  • INTERNET_EXPLORER
  • OPERA
  • SAFARI
required
browserVersionstring

The version of the browser that is used.

optional
comparatorstring

Compares different browsers together.

  • EQUALS
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN_OR_EQUAL
optional
platformstring

The platform on which the browser is being used.

  • ALL
  • DESKTOP
  • MOBILE
optional

The ContentCapture object

Settings for content capture.

ElementTypeDescriptionRequired
javaScriptErrorsboolean

JavaScript errors monitoring enabled/disabled.

required
resourceTimingSettingsResourceTimingSettings

Settings for resource timings capture.

required
timeoutSettingsTimeoutSettings

Settings for timed action capture.

required
visuallyComplete2SettingsVisuallyComplete2Settings

Settings for VisuallyComplete2

optional
visuallyCompleteAndSpeedIndexboolean

Visually complete and Speed index support enabled/disabled.

required

The ResourceTimingSettings object

Settings for resource timings capture.

ElementTypeDescriptionRequired
nonW3cResourceTimingsboolean

Timing for JavaScript files and images on non-W3C supported browsers enabled/disabled.

required
nonW3cResourceTimingsInstrumentationDelayinteger

Instrumentation delay for monitoring resource and image resource impact in browsers that don't offer W3C resource timings.

Valid values range from 0 to 9999.

Only effective if nonW3cResourceTimings is enabled.

required
resourceTimingCaptureTypestring

Defines how detailed resource timings are captured.

Only effective if w3cResourceTimings or nonW3cResourceTimings is enabled.

  • CAPTURE_ALL_SUMMARIES
  • CAPTURE_FULL_DETAILS
  • CAPTURE_LIMITED_SUMMARIES
optional
resourceTimingsDomainLimitinteger

Limits the number of domains for which W3C resource timings are captured.

Only effective if resourceTimingCaptureType is CAPTURE_LIMITED_SUMMARIES.

optional
w3cResourceTimingsboolean

W3C resource timings for third party/CDN enabled/disabled.

required

The TimeoutSettings object

Settings for timed action capture.

ElementTypeDescriptionRequired
temporaryActionLimitinteger

Defines how deep temporary actions may cascade. 0 disables temporary actions completely. Recommended value if enabled is 3.

required
temporaryActionTotalTimeoutinteger

The total timeout of all cascaded timeouts that should still be able to create a temporary action

required
timedActionSupportboolean

Timed action support enabled/disabled.

Enable to detect actions that trigger sending of XHRs via setTimout methods.

required

The VisuallyComplete2Settings object

Settings for VisuallyComplete2

ElementTypeDescriptionRequired
excludeUrlRegexstring

A RegularExpression used to exclude images and iframes from being detected by the VC module.

optional
ignoredMutationsListstring

Query selector for mutation nodes to ignore in VC and SI calculation

optional
inactivityTimeoutinteger

The time in ms the VC module waits for no mutations happening on the page after the load action. Defaults to 1000.

optional
mutationTimeoutinteger

Determines the time in ms VC waits after an action closes to start calculation. Defaults to 50.

optional
thresholdinteger

Minimum visible area in pixels of elements to be counted towards VC and SI. Defaults to 50.

optional

The WebApplicationConfigIpAddressRestrictionSettings object

Settings for restricting certain ip addresses and for introducing subnet mask. It also restricts the mode.

ElementTypeDescriptionRequired
ipAddressRestrictionsIpAddressRange[]-optional
modestring

The mode of the list of ip address restrictions.

  • EXCLUDE
  • INCLUDE
required

The IpAddressRange object

The IP address or the IP address range to be mapped to the location.

ElementTypeDescriptionRequired
addressstring

The IP address to be mapped.

For an IP address range, this is the from address.

required
addressTostring

The to address of the IP address range.

optional
subnetMaskinteger

The subnet mask of the IP address range.

optional

The JavaScriptFrameworkSupport object

Support of various JavaScript frameworks.

ElementTypeDescriptionRequired
activeXObjectboolean

ActiveXObject detection support enabled/disabled.

required
angularboolean

AngularJS and Angular support enabled/disabled.

required
dojoboolean

Dojo support enabled/disabled.

required
extJSboolean

ExtJS, Sencha Touch support enabled/disabled.

required
icefacesboolean

ICEfaces support enabled/disabled.

required
jQueryboolean

jQuery, Backbone.js support enabled/disabled.

required
mooToolsboolean

MooTools support enabled/disabled.

required
prototypeboolean

Prototype support enabled/disabled.

required

The JavaScriptInjectionRules object

Rules for javascript injection

ElementTypeDescriptionRequired
enabledboolean

The enable or disable rule of the java script injection.

required
htmlPatternstring

The html pattern of the java script injection.

optional
rulestring

The url rule of the java script injection.

  • AFTER_SPECIFIC_HTML
  • AUTOMATIC_INJECTION
  • BEFORE_SPECIFIC_HTML
  • DO_NOT_INJECT
required
targetstring

The target against which the rule of the java script injection should be matched.

  • PAGE_QUERY
  • URL
optional
urlOperatorstring

The url operator of the java script injection.

  • ALL_PAGES
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
required
urlPatternstring

The url pattern of the java script injection.

optional

The SessionReplaySetting object

Session replay settings

ElementTypeDescriptionRequired
costControlPercentageinteger

Session replay sampling rating in percentage.

required
cssResourceCapturingExclusionRulesstring[]

A list of URLs to be excluded from CSS resource capturing.

optional
enableCssResourceCapturingboolean

Capture (true) or don't capture (false) CSS resources from the session.

optional
enabledboolean

SessionReplay Enabled.

required

The UserActionAndSessionProperties object

Defines userAction and session custom defined properties settings of an application.

ElementTypeDescriptionRequired
aggregationstring

The aggregation type of the property.

It defines how multiple values of the property are aggregated.

  • AVERAGE
  • FIRST
  • LAST
  • MAXIMUM
  • MINIMUM
  • SUM
optional
cleanupRulestring

The cleanup rule of the property.

Defines how to extract the data you need from a string value. Specify the regular expression for the data you need there.

optional
displayNamestring

The display name of the property.

optional
ignoreCaseboolean

If true, the value of this property will always be stored in lower case. Defaults to false.

optional
keystring

Key of the property

required
longStringLengthinteger

If the type is LONG_STRING, the max length for this property. Must be a multiple of 100. Defaults to 200.

optional
metadataIdinteger

A reference to the uniqueId of a MetadataCapturingConfig.Must be set if "origin" is of type META_DATA.

optional
originstring

The origin of the property

  • JAVASCRIPT_API
  • META_DATA
  • SERVER_SIDE_REQUEST_ATTRIBUTE
required
serverSideRequestAttributestring

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

optional
storeAsSessionPropertyboolean

If true, the property is stored as a session property

optional
storeAsUserActionPropertyboolean

If true, the property is stored as a user action property

optional
typestring

The data type of the property.

  • DATE
  • DOUBLE
  • LONG
  • LONG_STRING
  • STRING
required
uniqueIdinteger

Unique id among all userTags and properties of this application

required

The UserActionNamingSettings object

The settings of user action naming.

ElementTypeDescriptionRequired
customActionNamingRulesUserActionNamingRule[]

User action naming rules for custom actions.

optional
ignoreCaseboolean

Case insensitive naming.

optional
loadActionNamingRulesUserActionNamingRule[]

User action naming rules for loading actions.

optional
placeholdersUserActionNamingPlaceholder[]

User action placeholders.

optional
queryParameterCleanupsstring[]

List of parameters that should be removed from the query before using the query in the user action name.

optional
splitUserActionsByDomainboolean

Deactivate this setting if different domains should not result in separate user actions.

optional
useFirstDetectedLoadActionboolean

First load action found under an XHR action should be used when true. Else the deepest one under the xhr action is used

optional
xhrActionNamingRulesUserActionNamingRule[]

User action naming rules for xhr actions.

optional

The UserActionNamingRule object

The settings of naming rule.

ElementTypeDescriptionRequired
conditionsUserActionNamingRuleCondition[]

Defines the conditions when the naming rule should apply.

optional
templatestring

Naming pattern. Use Curly brackets {} to select placeholders.

required
useOrConditionsboolean

If set to true the conditions will be connected by logical OR instead of logical AND.

optional

The UserActionNamingRuleCondition object

The settings of conditions for user action naming.

ElementTypeDescriptionRequired
operand1string

Must be a defined placeholder wrapped in curly braces

required
operand2string

Must be null if operator is "IS_EMPTY", a regex if operator is "MATCHES_REGULAR_ERPRESSION". In all other cases the value can be a freetext or a placeholder wrapped in curly braces

optional
operatorstring

The operator of the condition

  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • IS_EMPTY
  • IS_NOT_EMPTY
  • MATCHES_REGULAR_EXPRESSION
  • NOT_CONTAINS
  • NOT_ENDS_WITH
  • NOT_EQUALS
  • NOT_MATCHES_REGULAR_EXPRESSION
  • NOT_STARTS_WITH
  • STARTS_WITH
required

The UserActionNamingPlaceholder object

The placeholder settings.

ElementTypeDescriptionRequired
inputstring

Input.

  • ELEMENT_IDENTIFIER
  • INPUT_TYPE
  • METADATA
  • PAGE_TITLE
  • PAGE_URL
  • SOURCE_URL
  • TOP_XHR_URL
  • XHR_URL
required
metadataIdinteger

A reference to the uniqueId of a MetadataCapturingConfig. Must be set if "Input" is of type METADATA.

optional
namestring

Placeholder name.

required
processingPartstring

Part.

  • ALL
  • ANCHOR
  • PATH
required
processingStepsUserActionNamingPlaceholderProcessingStep[]

Processing actions.

optional
useGuessedElementIdentifierboolean

Use the element identifier that was selected by Dynatrace.

required

The UserActionNamingPlaceholderProcessingStep object

The processing step settings.

ElementTypeDescriptionRequired
fallbackToInputboolean

If set to true: Returns the input if patternBefore or patternAfter cannot be found and the type is SUBSTRING.

Returns the input if regularExpression doesn't match and type is EXTRACT_BY_REGULAR_EXPRESSION.

Otherwise null is returned.

optional
patternAfterstring

The pattern after the required value. It will be removed.

optional
patternAfterSearchTypestring

The required occurrence of patternAfter.

  • FIRST
  • LAST
optional
patternBeforestring

The pattern before the required value. It will be removed.

optional
patternBeforeSearchTypestring

The required occurrence of patternBefore.

  • FIRST
  • LAST
optional
patternToReplacestring

The pattern to be replaced.

Only applicable if the type is REPLACE_WITH_PATTERN.

optional
regularExpressionstring

A regular expression for the string to be extracted or replaced.

Only applicable if the type is EXTRACT_BY_REGULAR_EXPRESSION or REPLACE_WITH_REGULAR_EXPRESSION.

optional
replacementstring

Replacement for the original value.

optional
typestring

An action to be taken by the processing:

  • SUBSTRING: Extracts the string between patternBefore and patternAfter.
  • REPLACEMENT: Replaces the string between patternBefore and patternAfter with the specified replacement.
  • REPLACE_WITH_PATTERN: Replaces the patternToReplace with the specified replacement.
  • EXTRACT_BY_REGULAR_EXPRESSION: Extracts the part of the string that matches the regularExpression.
  • REPLACE_WITH_REGULAR_EXPRESSION: Replaces all occurrences that match regularExpression with the specified replacement.
  • REPLACE_IDS: Replaces all IDs and UUIDs with the specified replacement.
  • EXTRACT_BY_REGULAR_EXPRESSION
  • REPLACEMENT
  • REPLACE_IDS
  • REPLACE_WITH_PATTERN
  • REPLACE_WITH_REGULAR_EXPRESSION
  • SUBSTRING
required

The UserTag object

Defines UserTags settings of an application.

ElementTypeDescriptionRequired
cleanupRulestring

Cleanup rule expression of the userTag

optional
ignoreCaseboolean

If true, the value of this tag will always be stored in lower case. Defaults to false.

optional
metadataIdinteger

A reference to the uniqueId of a MetadataCapturingConfig. Must be set if the UserTag is based on metadata captured by the Javascript agent (e.g. a Javascript variable, CSS selector, etc.)

optional
serverSideRequestAttributestring

Serverside request attribute id of the userTag. Must be set if the UserTag is based on a serverside request attribute.

optional
uniqueIdinteger

uniqueId, unique among all userTags and properties of this application

required

The WaterfallSettings object

These settings influence the monitoring data you receive for 3rd party, CDN, and 1st party resources.

ElementTypeDescriptionRequired
resourceBrowserCachingThresholdinteger

Warn about resources with a lower browser cache rate above X%.

required
resourcesThresholdinteger

Warn about resources larger than X bytes.

required
slowCdnResourcesThresholdinteger

Warn about slow CDN resources with a response time above X ms.

required
slowFirstPartyResourcesThresholdinteger

Warn about slow 1st party resources with a response time above X ms.

required
slowThirdPartyResourcesThresholdinteger

Warn about slow 3rd party resources with a response time above X ms.

required
speedIndexVisuallyCompleteRatioThresholdinteger

Warn if Speed index exceeds X % of Visually complete.

required
uncompressedResourcesThresholdinteger

Warn about uncompressed resources larger than X bytes.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
"conversionGoals": [
{
"destinationDetails": {
"caseSensitive": false,
"matchType": "Begins",
"urlOrPath": "url or path"
},
"name": "conversionGoalName",
"type": "UserAction",
"userActionDetails": {
"actionType": "Load",
"caseSensitive": true,
"matchEntity": "ActionName",
"matchType": "Ends",
"value": "value to match"
},
"visitDurationDetails": {
"durationInMillis": 1
},
"visitNumActionDetails": {
"numUserActions": 2
}
}
],
"costControlUserSessionPercentage": 100,
"customActionApdexSettings": {
"frustratingFallbackThreshold": 12000,
"frustratingThreshold": 12000,
"toleratedFallbackThreshold": 3000,
"toleratedThreshold": 3000
},
"loadActionApdexSettings": {
"frustratingFallbackThreshold": 12000,
"frustratingThreshold": 12000,
"toleratedFallbackThreshold": 3000,
"toleratedThreshold": 3000
},
"loadActionKeyPerformanceMetric": "VISUALLY_COMPLETE",
"metaDataCaptureSettings": [
{
"capturingName": "variableName",
"name": "display name",
"type": "JAVA_SCRIPT_VARIABLE"
}
],
"monitoringSettings": {
"advancedJavaScriptTagSettings": {
"additionalEventHandlers": {
"blurEventHandler": false,
"changeEventHandler": false,
"clickEventHandler": false,
"maxDomNodesToInstrument": 5000,
"mouseupEventHandler": false,
"toStringMethod": false,
"userMouseupEventForClicks": false
},
"eventWrapperSettings": {
"blur": false,
"change": false,
"click": false,
"mouseUp": false,
"touchEnd": false,
"touchStart": false
},
"globalEventCaptureSettings": {
"additionalEventCapturedAsUserInput": "",
"click": true,
"doubleClick": true,
"keyDown": true,
"keyUp": true,
"mouseDown": true,
"mouseUp": true,
"scroll": true
},
"instrumentUnsupportedAjaxFrameworks": false,
"maxActionNameLength": 100,
"maxErrorsToCapture": 10,
"specialCharactersToEscape": "",
"syncBeaconFirefox": false,
"syncBeaconInternetExplorer": false
},
"browserRestrictionSettings": {
"browserRestrictions": [
{
"browserType": "INTERNET_EXPLORER",
"browserVersion": "0",
"comparator": "EQUALS",
"platform": "ALL"
}
],
"mode": "EXCLUDE"
},
"cacheControlHeaderOptimizations": true,
"contentCapture": {
"javaScriptErrors": true,
"resourceTimingSettings": {
"nonW3cResourceTimings": false,
"nonW3cResourceTimingsInstrumentationDelay": 50,
"w3cResourceTimings": true
},
"timeoutSettings": {
"temporaryActionLimit": 0,
"temporaryActionTotalTimeout": 100,
"timedActionSupport": false
},
"visuallyCompleteAndSpeedIndex": true
},
"cookiePlacementDomain": "",
"correlationHeaderInclusionRegex": "",
"customConfigurationProperties": "",
"excludeXhrRegex": "",
"fetchRequests": true,
"injectionMode": "JAVASCRIPT_TAG",
"ipAddressRestrictionSettings": {
"ipAddressRestrictions": [
{
"address": "10.0.0.1",
"subnetMask": 3
},
{
"address": "10.0.0.1",
"addressTo": "10.0.0.2"
}
],
"mode": "EXCLUDE"
},
"javaScriptFrameworkSupport": {
"activeXObject": false,
"angular": true,
"dojo": false,
"extJS": false,
"icefaces": false,
"jQuery": true,
"mooTools": false,
"prototype": true
},
"javaScriptInjectionRules": [
{
"enabled": true,
"htmlPattern": "</title>",
"rule": "AFTER_SPECIFIC_HTML",
"urlOperator": "CONTAINS",
"urlPattern": "/lorem/ipsum.jsp"
}
],
"libraryFileLocation": "",
"monitoringDataPath": "",
"secureCookieAttribute": false,
"serverRequestPathId": "",
"xmlHttpRequest": true
},
"name": "application name",
"realUserMonitoringEnabled": true,
"sessionReplayConfig": {
"costControlPercentage": 100,
"cssResourceCapturingExclusionRules": [
"rule"
],
"enableCssResourceCapturing": true,
"enabled": true
},
"type": "AUTO_INJECTED",
"userActionNamingSettings": {
"ignoreCase": true,
"loadActionNamingRules": [
{
"conditions": [
{
"operand1": "{myPlaceholder}",
"operand2": "foo",
"operator": "CONTAINS"
}
],
"template": "Loading of {myPlaceholder}"
}
],
"placeholders": [
{
"input": "PAGE_URL",
"name": "myPlaceholder",
"processingPart": "ALL",
"processingSteps": [
{
"patternAfter": ".*a",
"patternAfterSearchType": "LAST",
"patternBefore": ".*b",
"patternBeforeSearchType": "FIRST",
"replacement": "value",
"type": "SUBSTRING"
}
],
"useGuessedElementIdentifier": false
}
],
"splitUserActionsByDomain": true,
"xhrActionNamingRules": [
{
"conditions": [
{
"operand1": "{myPlaceholder}",
"operand2": "foo",
"operator": "CONTAINS"
}
],
"template": "Loading of {myPlaceholder}"
}
]
},
"waterfallSettings": {
"resourceBrowserCachingThreshold": 50,
"resourcesThreshold": 100000,
"slowCdnResourcesThreshold": 200000,
"slowFirstPartyResourcesThreshold": 200000,
"slowThirdPartyResourcesThreshold": 200000,
"speedIndexVisuallyCompleteRatioThreshold": 50,
"uncompressedResourcesThreshold": 860
},
"xhrActionApdexSettings": {
"frustratingFallbackThreshold": 12000,
"frustratingThreshold": 10000,
"toleratedFallbackThreshold": 3000,
"toleratedThreshold": 2500
},
"xhrActionKeyPerformanceMetric": "ACTION_DURATION"
}

Response

Response codes

CodeTypeDescription
204-

Success. Configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/default/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204-

Validated. The submitted configuration is valid. Response does not have a body.

400ErrorEnvelope

Failed. The input is invalid.