Web application configuration API - PUT a web application

Reference
Published Sep 03, 2019

Updates the specified web application.

This API only supports web applications. For mobile and custom applications, see Mobile and custom app API.

The request consumes and produces an application/json payload.

PUT	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}`
PUT	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/{id}`

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

Parameter	Type	Description	In	Required
id	string	The ID of the web application to update. If you set the ID in the body as well, it must match this ID.	path	required
body	WebApplicationConfig	JSON body of the request, containing updated configuration of the web application.	body	optional

Parameter

Type

Description

Required

string

The ID of the web application to update.

If you set the ID in the body as well, it must match this ID.

path

required

body

WebApplicationConfig

JSON body of the request, containing updated configuration of the web application.

body

optional

Request body objects

The `WebApplicationConfig` object

Configuration of a web application.

Element	Type	Description	Required
conversionGoals	ConversionGoal[]	A list of conversion goals of the application.	optional
costControlUserSessionPercentage	number	Analize X% of user sessions.	required
customActionApdexSettings	Apdex	Defines the Apdex settings of an application.	required
identifier	string	Dynatrace entity ID of the web application.	optional
loadActionApdexSettings	Apdex	Defines the Apdex settings of an application.	required
loadActionKeyPerformanceMetric	string	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
metaDataCaptureSettings	MetaDataCapturing[]	Java script agent meta data capture settings.	optional
metadata	ConfigurationMetadata	Metadata useful for debugging	optional
monitoringSettings	MonitoringSettings	Real user monitoring settings.	required
name	string	The name of the web application, displayed in the UI.	required
realUserMonitoringEnabled	boolean	Real user monitoring enabled/disabled.	required
sessionReplayConfig	SessionReplaySetting	Session replay settings	optional
type	string	The type of the web application. `AUTO_INJECTED` `BROWSER_EXTENSION_INJECTED` `MANUALLY_INJECTED`	optional
urlInjectionPattern	string	Url injection pattern for manual web application.	optional
userActionAndSessionProperties	UserActionAndSessionProperties[]	User action and session properties settings. Empty List means no change	optional
userActionNamingSettings	UserActionNamingSettings	The settings of user action naming.	optional
userTags	UserTag[]	User tags settings.	optional
waterfallSettings	WaterfallSettings	These settings influence the monitoring data you receive for 3rd party, CDN, and 1st party resources.	required
xhrActionApdexSettings	Apdex	Defines the Apdex settings of an application.	required
xhrActionKeyPerformanceMetric	string	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.

Element	Type	Description	Required
destinationDetails	DestinationDetails	Configuration of a destination-based conversion goal.	optional
id	string	The ID of conversion goal. Omit it while creating a new conversion goal.	optional
name	string	The name of the conversion goal.	required
type	string	The type of the conversion goal. `Destination` `UserAction` `VisitDuration` `VisitNumActions`	optional
userActionDetails	UserActionDetails	Configuration of a user action-based conversion goal.	optional
visitDurationDetails	VisitDurationDetails	Configuration of a visit duration-based conversion goal.	optional
visitNumActionDetails	VisitNumActionDetails	Configuration of a number of user actions-based conversion goal.	optional

The `DestinationDetails` object

Configuration of a destination-based conversion goal.

Element	Type	Description	Required
caseSensitive	boolean	The match is case-sensitive (`true`) or (`false`).	optional
matchType	string	The operator of the match. `Begins` `Contains` `Ends`	optional
urlOrPath	string	The path to be reached to hit the conversion goal.	required

The `UserActionDetails` object

Configuration of a user action-based conversion goal.

Element	Type	Description	Required
actionType	string	Type of the action to which the rule applies. `Custom` `Load` `Xhr`	optional
caseSensitive	boolean	The match is case-sensitive (`true`) or (`false`).	optional
matchEntity	string	The type of the entity to which the rule applies. `ActionName` `PageUrl`	optional
matchType	string	The operator of the match. `Begins` `Contains` `Ends`	optional
value	string	The value to be matched to hit the conversion goal.	optional

The `VisitDurationDetails` object

Configuration of a visit duration-based conversion goal.

Element	Type	Description	Required
durationInMillis	integer	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.

Element	Type	Description	Required
numUserActions	integer	The number of user actions to hit the conversion goal.	optional

The `Apdex` object

Defines the Apdex settings of an application.

Element	Type	Description	Required
frustratingFallbackThreshold	number	Fallback threshold of an XHR action, defining a tolerable user experience, when the configured KPM is not available.	optional
frustratingThreshold	number	Maximal value of apdex, which is considered as tolerable user experience.	optional
toleratedFallbackThreshold	number	Fallback threshold of an XHR action, defining a satisfied user experience, when the configured KPM is not available.	optional
toleratedThreshold	number	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

Element	Type	Description	Required
capturingName	string	The name of the meta data to capture.	required
name	string	Name for displaying the captured values in Dynatrace.	required
publicMetadata	boolean	True if this metadata should be captured regardless of the privacy settings	optional
type	string	The type of the meta data to capture. `COOKIE` `CSS_SELECTOR` `JAVA_SCRIPT_FUNCTION` `JAVA_SCRIPT_VARIABLE` `META_TAG` `QUERY_STRING` `RESPONSE_HEADER`	required
uniqueId	integer	The unique id of the meta data to capture.	optional
useLastValue	boolean	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

Element	Type	Description	Required
clusterVersion	string	Dynatrace version.	optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	optional

The `MonitoringSettings` object

Real user monitoring settings.

Element	Type	Description	Required
addCrossOriginAnonymousAttribute	boolean	Add the cross origin = anonymous attribute to capture JavaScript error messages and W3C resource timings.	optional
advancedJavaScriptTagSettings	AdvancedJavaScriptTagSettings	Advanced JavaScript tag settings.	required
angularPackageName	string	The name of the angular package.	optional
browserRestrictionSettings	WebApplicationConfigBrowserRestrictionSettings	Settings for restricting certain browser type, version, platform and, comparator. It also restricts the mode.	optional
cacheControlHeaderOptimizations	boolean	Optimize the value of cache control headers for use with Dynatrace real user monitoring enabled/disabled.	required
contentCapture	ContentCapture	Settings for content capture.	required
cookiePlacementDomain	string	Domain for cookie placement.	optional
correlationHeaderInclusionRegex	string	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
customConfigurationProperties	string	Additional JavaScript tag properties that are specific to your application. To do this, type key=value pairs separated using a (\|) symbol.	required
excludeXhrRegex	string	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
fetchRequests	boolean	`fetch()` request capture enabled/disabled.	required
injectionMode	string	JavaScript injection mode. `CODE_SNIPPET` `CODE_SNIPPET_ASYNC` `INLINE_CODE` `JAVASCRIPT_TAG` `JAVASCRIPT_TAG_COMPLETE` `JAVASCRIPT_TAG_SRI`	required
instrumentedWebServer	boolean	Instrumented web or app server.	optional
ipAddressRestrictionSettings	WebApplicationConfigIpAddressRestrictionSettings	Settings for restricting certain ip addresses and for introducing subnet mask. It also restricts the mode.	optional
javaScriptFrameworkSupport	JavaScriptFrameworkSupport	Support of various JavaScript frameworks.	required
javaScriptInjectionRules	JavaScriptInjectionRules[]	Java script injection rules.	optional
libraryFileFromCdn	boolean	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
libraryFileLocation	string	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
monitoringDataPath	string	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
sameSiteCookieAttribute	string	Same site cookie attribute `LAX` `NONE` `STRICT`	optional
scriptTagCacheDurationInHours	integer	Time duration for the cache settings.	optional
secureCookieAttribute	boolean	Secure attribute usage for Dynatrace cookies enabled/disabled.	required
serverRequestPathId	string	Path to identify the server’s request ID.	required
useCors	boolean	Send beacon data via CORS.	optional
xmlHttpRequest	boolean	`XmlHttpRequest` support enabled/disabled.	required

The `AdvancedJavaScriptTagSettings` object

Advanced JavaScript tag settings.

Element	Type	Description	Required
additionalEventHandlers	AdditionalEventHandlers	Additional event handlers and wrappers.	required
eventWrapperSettings	EventWrapperSettings	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
globalEventCaptureSettings	GlobalEventCaptureSettings	Global event capture settings.	required
instrumentUnsupportedAjaxFrameworks	boolean	Instrumentation of unsupported Ajax frameworks enabled/disabled.	required
maxActionNameLength	integer	Maximum character length for action names. Valid values range from 5 to 10000.	required
maxErrorsToCapture	integer	Maximum number of errors to be captured per page. Valid values range from 0 to 50.	required
proxyWrapperEnabled	boolean	Proxy wrapper enabled/disabled.	optional
specialCharactersToEscape	string	Additional special characters that are to be escaped using non-alphanumeric characters in HTML escape format.	required
syncBeaconFirefox	boolean	Send the beacon signal as a synchronous XMLHttpRequest using Firefox enabled/disabled.	optional
syncBeaconInternetExplorer	boolean	Send the beacon signal as a synchronous XMLHttpRequest using Internet Explorer enabled/disabled.	optional
userActionNameAttribute	string	User action name attribute.	optional

The `AdditionalEventHandlers` object

Additional event handlers and wrappers.

Element	Type	Description	Required
blurEventHandler	boolean	Blur event handler enabled/disabled.	required
changeEventHandler	boolean	Change event handler enabled/disabled.	required
clickEventHandler	boolean	Click event handler enabled/disabled.	required
maxDomNodesToInstrument	integer	Max. number of DOM nodes to instrument. Valid values range from 0 to 100000.	required
mouseupEventHandler	boolean	Mouseup event handler enabled/disabled.	required
toStringMethod	boolean	toString method enabled/disabled.	required
userMouseupEventForClicks	boolean	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.

Element	Type	Description	Required
blur	boolean	Blur enabled/disabled.	required
change	boolean	Change enabled/disabled.	required
click	boolean	Click enabled/disabled.	required
mouseUp	boolean	MouseUp enabled/disabled.	required
touchEnd	boolean	TouchEnd enabled/disabled.	required
touchStart	boolean	TouchStart enabled/disabled.	required

The `GlobalEventCaptureSettings` object

Global event capture settings.

Element	Type	Description	Required
additionalEventCapturedAsUserInput	string	Additional events to be captured globally as user input. For example, DragStart or DragEnd.	required
change	boolean	Change enabled/disabled.	optional
click	boolean	Click enabled/disabled.	required
doubleClick	boolean	DoubleClick enabled/disabled.	required
keyDown	boolean	KeyDown enabled/disabled.	required
keyUp	boolean	KeyUp enabled/disabled.	required
mouseDown	boolean	MouseDown enabled/disabled.	required
mouseUp	boolean	MouseUp enabled/disabled.	required
scroll	boolean	Scroll enabled/disabled.	required
touchEnd	boolean	TouchEnd enabled/disabled.	optional
touchStart	boolean	TouchStart enabled/disabled.	optional

The `WebApplicationConfigBrowserRestrictionSettings` object

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

Element	Type	Description	Required
browserRestrictions	WebApplicationConfigBrowserRestriction[]	A list of browser restrictions.	optional
mode	string	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.

Element	Type	Description	Required
browserType	string	The type of the browser that is used. `ANDROID_WEBKIT` `BOTS_SPIDERS` `CHROME` `CHROME_HEADLESS` `EDGE` `FIREFOX` `INTERNET_EXPLORER` `OPERA` `SAFARI`	required
browserVersion	string	The version of the browser that is used.	optional
comparator	string	Compares different browsers together. `EQUALS` `GREATER_THAN_OR_EQUAL` `LOWER_THAN_OR_EQUAL`	optional
platform	string	The platform on which the browser is being used. `ALL` `DESKTOP` `MOBILE`	optional

The `ContentCapture` object

Settings for content capture.

Element	Type	Description	Required
javaScriptErrors	boolean	JavaScript errors monitoring enabled/disabled.	required
resourceTimingSettings	ResourceTimingSettings	Settings for resource timings capture.	required
timeoutSettings	TimeoutSettings	Settings for timed action capture.	required
visuallyComplete2Settings	VisuallyComplete2Settings	Settings for VisuallyComplete2	optional
visuallyCompleteAndSpeedIndex	boolean	Visually complete and Speed index support enabled/disabled.	required

The `ResourceTimingSettings` object

Settings for resource timings capture.

Element	Type	Description	Required
nonW3cResourceTimings	boolean	Timing for JavaScript files and images on non-W3C supported browsers enabled/disabled.	required
nonW3cResourceTimingsInstrumentationDelay	integer	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
resourceTimingCaptureType	string	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
resourceTimingsDomainLimit	integer	Limits the number of domains for which W3C resource timings are captured. Only effective if resourceTimingCaptureType is `CAPTURE_LIMITED_SUMMARIES`.	optional
w3cResourceTimings	boolean	W3C resource timings for third party/CDN enabled/disabled.	required

The `TimeoutSettings` object

Settings for timed action capture.

Element	Type	Description	Required
temporaryActionLimit	integer	Defines how deep temporary actions may cascade. 0 disables temporary actions completely. Recommended value if enabled is 3.	required
temporaryActionTotalTimeout	integer	The total timeout of all cascaded timeouts that should still be able to create a temporary action	required
timedActionSupport	boolean	Timed action support enabled/disabled. Enable to detect actions that trigger sending of XHRs via setTimout methods.	required

Element

Type

Description

Required

temporaryActionLimit

integer

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

required

temporaryActionTotalTimeout

integer

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

required

timedActionSupport

boolean

Timed action support enabled/disabled.

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

required

The `VisuallyComplete2Settings` object

Settings for VisuallyComplete2

Element	Type	Description	Required
excludeUrlRegex	string	A RegularExpression used to exclude images and iframes from being detected by the VC module.	optional
ignoredMutationsList	string	Query selector for mutation nodes to ignore in VC and SI calculation	optional
inactivityTimeout	integer	The time in ms the VC module waits for no mutations happening on the page after the load action. Defaults to 1000.	optional
mutationTimeout	integer	Determines the time in ms VC waits after an action closes to start calculation. Defaults to 50.	optional
threshold	integer	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.

Element	Type	Description	Required
ipAddressRestrictions	IpAddressRange[]	-	optional
mode	string	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.

Element	Type	Description	Required
address	string	The IP address to be mapped. For an IP address range, this is the from address.	required
addressTo	string	The to address of the IP address range.	optional
subnetMask	integer	The subnet mask of the IP address range.	optional

Element

Type

Description

Required

address

string

The IP address to be mapped.

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

required

addressTo

string

The to address of the IP address range.

optional

subnetMask

integer

The subnet mask of the IP address range.

optional

The `JavaScriptFrameworkSupport` object

Support of various JavaScript frameworks.

Element	Type	Description	Required
activeXObject	boolean	ActiveXObject detection support enabled/disabled.	required
angular	boolean	AngularJS and Angular support enabled/disabled.	required
dojo	boolean	Dojo support enabled/disabled.	required
extJS	boolean	ExtJS, Sencha Touch support enabled/disabled.	required
icefaces	boolean	ICEfaces support enabled/disabled.	required
jQuery	boolean	jQuery, Backbone.js support enabled/disabled.	required
mooTools	boolean	MooTools support enabled/disabled.	required
prototype	boolean	Prototype support enabled/disabled.	required

The `JavaScriptInjectionRules` object

Rules for javascript injection

Element	Type	Description	Required
enabled	boolean	The enable or disable rule of the java script injection.	required
htmlPattern	string	The html pattern of the java script injection.	optional
rule	string	The url rule of the java script injection. `AFTER_SPECIFIC_HTML` `AUTOMATIC_INJECTION` `BEFORE_SPECIFIC_HTML` `DO_NOT_INJECT`	required
target	string	The target against which the rule of the java script injection should be matched. `PAGE_QUERY` `URL`	optional
urlOperator	string	The url operator of the java script injection. `ALL_PAGES` `CONTAINS` `ENDS_WITH` `EQUALS` `STARTS_WITH`	required
urlPattern	string	The url pattern of the java script injection.	optional

The `SessionReplaySetting` object

Session replay settings

Element	Type	Description	Required
costControlPercentage	integer	Session replay sampling rating in percentage.	required
cssResourceCapturingExclusionRules	string[]	A list of URLs to be excluded from CSS resource capturing.	optional
enableCssResourceCapturing	boolean	Capture (`true`) or don't capture (`false`) CSS resources from the session.	optional
enabled	boolean	SessionReplay Enabled.	required

The `UserActionAndSessionProperties` object

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

Element	Type	Description	Required
aggregation	string	The aggregation type of the property. It defines how multiple values of the property are aggregated. `AVERAGE` `FIRST` `LAST` `MAXIMUM` `MINIMUM` `SUM`	optional
cleanupRule	string	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
displayName	string	The display name of the property.	optional
ignoreCase	boolean	If true, the value of this property will always be stored in lower case. Defaults to false.	optional
key	string	Key of the property	required
longStringLength	integer	If the type is LONG_STRING, the max length for this property. Must be a multiple of 100. Defaults to 200.	optional
metadataId	integer	A reference to the uniqueId of a MetadataCapturingConfig.Must be set if "origin" is of type META_DATA.	optional
origin	string	The origin of the property `JAVASCRIPT_API` `META_DATA` `SERVER_SIDE_REQUEST_ATTRIBUTE`	required
serverSideRequestAttribute	string	The ID of the request attribute. Only applicable when the origin is set to `SERVER_SIDE_REQUEST_ATTRIBUTE`.	optional
storeAsSessionProperty	boolean	If `true`, the property is stored as a session property	optional
storeAsUserActionProperty	boolean	If `true`, the property is stored as a user action property	optional
type	string	The data type of the property. `DATE` `DOUBLE` `LONG` `LONG_STRING` `STRING`	required
uniqueId	integer	Unique id among all userTags and properties of this application	required

The `UserActionNamingSettings` object

The settings of user action naming.

Element	Type	Description	Required
customActionNamingRules	UserActionNamingRule[]	User action naming rules for custom actions.	optional
ignoreCase	boolean	Case insensitive naming.	optional
loadActionNamingRules	UserActionNamingRule[]	User action naming rules for loading actions.	optional
placeholders	UserActionNamingPlaceholder[]	User action placeholders.	optional
queryParameterCleanups	string[]	List of parameters that should be removed from the query before using the query in the user action name.	optional
splitUserActionsByDomain	boolean	Deactivate this setting if different domains should not result in separate user actions.	optional
useFirstDetectedLoadAction	boolean	First load action found under an XHR action should be used when true. Else the deepest one under the xhr action is used	optional
xhrActionNamingRules	UserActionNamingRule[]	User action naming rules for xhr actions.	optional

The `UserActionNamingRule` object

The settings of naming rule.

Element	Type	Description	Required
conditions	UserActionNamingRuleCondition[]	Defines the conditions when the naming rule should apply.	optional
template	string	Naming pattern. Use Curly brackets `{}` to select placeholders.	required
useOrConditions	boolean	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.

Element	Type	Description	Required
operand1	string	Must be a defined placeholder wrapped in curly braces	required
operand2	string	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
operator	string	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.

Element	Type	Description	Required
input	string	Input. `ELEMENT_IDENTIFIER` `INPUT_TYPE` `METADATA` `PAGE_TITLE` `PAGE_URL` `SOURCE_URL` `TOP_XHR_URL` `XHR_URL`	required
metadataId	integer	A reference to the uniqueId of a MetadataCapturingConfig. Must be set if "Input" is of type METADATA.	optional
name	string	Placeholder name.	required
processingPart	string	Part. `ALL` `ANCHOR` `PATH`	required
processingSteps	UserActionNamingPlaceholderProcessingStep[]	Processing actions.	optional
useGuessedElementIdentifier	boolean	Use the element identifier that was selected by Dynatrace.	required

The `UserActionNamingPlaceholderProcessingStep` object

The processing step settings.

Element	Type	Description	Required
fallbackToInput	boolean	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
patternAfter	string	The pattern after the required value. It will be removed.	optional
patternAfterSearchType	string	The required occurrence of patternAfter. `FIRST` `LAST`	optional
patternBefore	string	The pattern before the required value. It will be removed.	optional
patternBeforeSearchType	string	The required occurrence of patternBefore. `FIRST` `LAST`	optional
patternToReplace	string	The pattern to be replaced. Only applicable if the type is `REPLACE_WITH_PATTERN`.	optional
regularExpression	string	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
replacement	string	Replacement for the original value.	optional
type	string	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.

Element	Type	Description	Required
cleanupRule	string	Cleanup rule expression of the userTag	optional
ignoreCase	boolean	If true, the value of this tag will always be stored in lower case. Defaults to false.	optional
metadataId	integer	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
serverSideRequestAttribute	string	Serverside request attribute id of the userTag. Must be set if the UserTag is based on a serverside request attribute.	optional
uniqueId	integer	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.

Element	Type	Description	Required
resourceBrowserCachingThreshold	integer	Warn about resources with a lower browser cache rate above X%.	required
resourcesThreshold	integer	Warn about resources larger than X bytes.	required
slowCdnResourcesThreshold	integer	Warn about slow CDN resources with a response time above X ms.	required
slowFirstPartyResourcesThreshold	integer	Warn about slow 1st party resources with a response time above X ms.	required
slowThirdPartyResourcesThreshold	integer	Warn about slow 3rd party resources with a response time above X ms.	required
speedIndexVisuallyCompleteRatioThreshold	integer	Warn if Speed index exceeds X % of Visually complete.	required
uncompressedResourcesThreshold	integer	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

Code	Type	Description
201	EntityShortRepresentation	Success. The new configuration has been created. The response body contains the ID and name of the new web application.
204	-	Success. Configuration has been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description
description	string	A short description of the Dynatrace entity.
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

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.

POST	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/{id}/validator`
POST	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/{id}/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

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response does not have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Web application configuration API - PUT a web application

Authentication

Parameters

Request body objects

The WebApplicationConfig object

The ConversionGoal object

The DestinationDetails object

The UserActionDetails object

The VisitDurationDetails object

The VisitNumActionDetails object

The Apdex object

The MetaDataCapturing object

The ConfigurationMetadata object

The MonitoringSettings object

The AdvancedJavaScriptTagSettings object

The AdditionalEventHandlers object

The EventWrapperSettings object

The GlobalEventCaptureSettings object

The WebApplicationConfigBrowserRestrictionSettings object

The WebApplicationConfigBrowserRestriction object

The ContentCapture object

The ResourceTimingSettings object

The TimeoutSettings object

The VisuallyComplete2Settings object

The WebApplicationConfigIpAddressRestrictionSettings object

The IpAddressRange object

The JavaScriptFrameworkSupport object

The JavaScriptInjectionRules object

The SessionReplaySetting object

The UserActionAndSessionProperties object

The UserActionNamingSettings object

The UserActionNamingRule object

The UserActionNamingRuleCondition object

The UserActionNamingPlaceholder object

The UserActionNamingPlaceholderProcessingStep object

The UserTag object

The WaterfallSettings object

Request body JSON model

Response

Response codes

Response body objects

The EntityShortRepresentation object

Response body JSON model

Validate payload

Authentication

Response

Response codes

The `WebApplicationConfig` object

The `ConversionGoal` object

The `DestinationDetails` object

The `UserActionDetails` object

The `VisitDurationDetails` object

The `VisitNumActionDetails` object

The `Apdex` object

The `MetaDataCapturing` object

The `ConfigurationMetadata` object

The `MonitoringSettings` object

The `AdvancedJavaScriptTagSettings` object

The `AdditionalEventHandlers` object

The `EventWrapperSettings` object

The `GlobalEventCaptureSettings` object

The `WebApplicationConfigBrowserRestrictionSettings` object

The `WebApplicationConfigBrowserRestriction` object

The `ContentCapture` object

The `ResourceTimingSettings` object

The `TimeoutSettings` object

The `VisuallyComplete2Settings` object

The `WebApplicationConfigIpAddressRestrictionSettings` object

The `IpAddressRange` object

The `JavaScriptFrameworkSupport` object

The `JavaScriptInjectionRules` object

The `SessionReplaySetting` object

The `UserActionAndSessionProperties` object

The `UserActionNamingSettings` object

The `UserActionNamingRule` object

The `UserActionNamingRuleCondition` object

The `UserActionNamingPlaceholder` object

The `UserActionNamingPlaceholderProcessingStep` object

The `UserTag` object

The `WaterfallSettings` object

The `EntityShortRepresentation` object