Web application configuration API - POST a web application

Creates a new web application.

This API only supports web applications (including agentless applications and browser extensions). For mobile apps and custom applications, see Mobile and custom app API.

The request consumes and produces an application/json payload.

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

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	WebApplicationConfig	JSON body of the request, containing parameters of the new web application configuraiton.	body	optional

Request body objects

The `WebApplicationConfig` object

Configuration of a web application.

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

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `SessionReplaySetting` object

Session replay settings

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

The `Apdex` object

Defines the Apdex settings of an application.

Element	Type	Description
toleratedThreshold	number	Maximal value of apdex, which is considered as satisfied user experience. Can be `null`.
frustratingThreshold	number	Maximal value of apdex, which is considered as tolerable user experience. Can be `null`.
toleratedFallbackThreshold	number	Fallback threshold of an XHR action, defining a satisfied user experience, when the configured KPM is not available. Can be `null`.
frustratingFallbackThreshold	number	Fallback threshold of an XHR action, defining a tolerable user experience, when the configured KPM is not available. Can be `null`.

The `WaterfallSettings` object

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

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

The `MonitoringSettings` object

Real user monitoring settings.

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

The `JavaScriptFrameworkSupport` object

Support of various JavaScript frameworks.

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

The `ContentCapture` object

Settings for content capture.

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

The `ResourceTimingSettings` object

Settings for resource timings capture.

Element	Type	Description
w3cResourceTimings	boolean	W3C resource timings for third party/CDN enabled/disabled.
nonW3cResourceTimings	boolean	Timing for JavaScript files and images on non-W3C supported browsers enabled/disabled.
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.
resourceTimingCaptureType	string	Defines how detailed resource timings are captured. Only effective if w3cResourceTimings or nonW3cResourceTimings is enabled. The element can hold these values `CAPTURE_ALL_SUMMARIES` `CAPTURE_FULL_DETAILS` `CAPTURE_LIMITED_SUMMARIES` Can be `null`.
resourceTimingsDomainLimit	integer	Limits the number of domains for which W3C resource timings are captured. Only effective if resourceTimingCaptureType is `CAPTURE_LIMITED_SUMMARIES`. Can be `null`.

The `TimeoutSettings` object

Settings for timed action capture.

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

Element

Type

Description

timedActionSupport

boolean

Timed action support enabled/disabled.

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

temporaryActionLimit

integer

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

temporaryActionTotalTimeout

integer

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

The `VisuallyComplete2Settings` object

Settings for VisuallyComplete2

Element	Type	Description
excludeUrlRegex	string	A RegularExpression used to exclude images and iframes from being detected by the VC module. Can be `null`.
ignoredMutationsList	string	Query selector for mutation nodes to ignore in VC and SI calculation Can be `null`.
mutationTimeout	integer	Determines the time in ms VC waits after an action closes to start calculation. Defaults to 50. Can be `null`.
inactivityTimeout	integer	The time in ms the VC module waits for no mutations happening on the page after the load action. Defaults to 1000. Can be `null`.
threshold	integer	Minimum visible area in pixels of elements to be counted towards VC and SI. Defaults to 50. Can be `null`.

The `AdvancedJavaScriptTagSettings` object

Advanced JavaScript tag settings.

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

The `AdditionalEventHandlers` object

Additional event handlers and wrappers.

Element	Type	Description
userMouseupEventForClicks	boolean	Use mouseup event for clicks enabled/disabled.
clickEventHandler	boolean	Click event handler enabled/disabled.
mouseupEventHandler	boolean	Mouseup event handler enabled/disabled.
blurEventHandler	boolean	Blur event handler enabled/disabled.
changeEventHandler	boolean	Change event handler enabled/disabled.
toStringMethod	boolean	toString method enabled/disabled.
maxDomNodesToInstrument	integer	Max. number of DOM nodes to instrument. Valid values range from 0 to 100000.

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
click	boolean	Click enabled/disabled.
mouseUp	boolean	MouseUp enabled/disabled.
change	boolean	Change enabled/disabled.
blur	boolean	Blur enabled/disabled.
touchStart	boolean	TouchStart enabled/disabled.
touchEnd	boolean	TouchEnd enabled/disabled.

The `GlobalEventCaptureSettings` object

Global event capture settings.

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

The `WebApplicationConfigBrowserRestrictionSettings` object

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

Element Type Description

mode

string

Element	Type	Description
mode	string	The mode of the list of browser restrictions. The element can hold these values `EXCLUDE` `INCLUDE`
browserRestrictions	WebApplicationConfigBrowserRestriction[]	A list of browser restrictions. Can be `null`.

The mode of the list of browser restrictions.

The element can hold these values

EXCLUDE
INCLUDE

browserRestrictions

WebApplicationConfigBrowserRestriction[]

A list of browser restrictions.

Can be null.

The `WebApplicationConfigBrowserRestriction` object

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

Element	Type	Description
browserVersion	string	The version of the browser that is used. Can be `null`.
browserType	string	The type of the browser that is used. The element can hold these values `ANDROID_WEBKIT` `BOTS_SPIDERS` `CHROME` `EDGE` `FIREFOX` `INTERNET_EXPLORER` `OPERA` `SAFARI`
platform	string	The platform on which the browser is being used. The element can hold these values `ALL` `DESKTOP` `MOBILE` Can be `null`.
comparator	string	Compares different browsers together. The element can hold these values `EQUALS` `GREATER_THAN_OR_EQUAL` `LOWER_THAN_OR_EQUAL` Can be `null`.

The `WebApplicationConfigIpAddressRestrictionSettings` object

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

Element	Type	Description
mode	string	The mode of the list of ip address restrictions. The element can hold these values `EXCLUDE` `INCLUDE`
ipAddressRestrictions	IpAddressRange[]	- Can be `null`.

The `IpAddressRange` object

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

Element Type Description

subnetMask

integer

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

The subnet mask of the IP address range.

Can be null.

address

string

The IP address to be mapped.

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

addressTo

string

The to address of the IP address range.

Can be null.

The `JavaScriptInjectionRules` object

Rules for javascript injection

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

The `UserTag` object

Defines UserTags settings of an application.

Element	Type	Description
uniqueId	integer	uniqueId, unique among all userTags and properties of this application
metadataId	integer	If it's of type metaData, metaData id of the userTag Can be `null`.
cleanupRule	string	Cleanup rule expression of the userTag Can be `null`.
serverSideRequestAttribute	string	requestAttribute Id of the userTag Can be `null`.
ignoreCase	boolean	If true, the value of this tag will always be stored in lower case. Defaults to false. Can be `null`.

The `UserActionAndSessionProperties` object

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

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

The `UserActionNamingSettings` object

The settings of user action naming.

Element	Type	Description
placeholders	UserActionNamingPlaceholder[]	User action placeholders. Can be `null`.
loadActionNamingRules	UserActionNamingRule[]	User action naming rules for loading actions. Can be `null`.
xhrActionNamingRules	UserActionNamingRule[]	User action naming rules for xhr actions. Can be `null`.
customActionNamingRules	UserActionNamingRule[]	User action naming rules for custom actions. Can be `null`.
ignoreCase	boolean	Case insensitive naming. Can be `null`.
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 Can be `null`.
splitUserActionsByDomain	boolean	Deactivate this setting if different domains should not result in separate user actions. Can be `null`.
queryParameterCleanups	string[]	List of parameters that should be removed from the query before using the query in the user action name. Can be `null`.

The `UserActionNamingPlaceholder` object

The placeholder settings.

Element	Type	Description
name	string	Placeholder name.
input	string	Input. The element can hold these values `ELEMENT_IDENTIFIER` `INPUT_TYPE` `METADATA` `PAGE_TITLE` `PAGE_URL` `SOURCE_URL` `TOP_XHR_URL` `XHR_URL`
processingPart	string	Part. The element can hold these values `ALL` `ANCHOR` `PATH`
processingSteps	UserActionNamingPlaceholderProcessingStep[]	Processing actions. Can be `null`.
metadataId	integer	Id of the metadata. Can be `null`.
useGuessedElementIdentifier	boolean	Use the element identifier that was selected by Dynatrace.

The `UserActionNamingPlaceholderProcessingStep` object

The processing step settings.

Element	Type	Description
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. The element can hold these values `EXTRACT_BY_REGULAR_EXPRESSION` `REPLACEMENT` `REPLACE_IDS` `REPLACE_WITH_PATTERN` `REPLACE_WITH_REGULAR_EXPRESSION` `SUBSTRING`
patternBefore	string	The pattern before the required value. It will be removed. Can be `null`.
patternBeforeSearchType	string	The required occurrence of patternBefore. The element can hold these values `FIRST` `LAST` Can be `null`.
patternAfter	string	The pattern after the required value. It will be removed. Can be `null`.
patternAfterSearchType	string	The required occurrence of patternAfter. The element can hold these values `FIRST` `LAST` Can be `null`.
replacement	string	Replacement for the original value. Can be `null`.
patternToReplace	string	The pattern to be replaced. Only applicable if the type is `REPLACE_WITH_PATTERN`. Can be `null`.
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`. Can be `null`.
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. Can be `null`.

The `UserActionNamingRule` object

The settings of naming rule.

Element Type Description

template

string

Element	Type	Description
template	string	Naming pattern. Use Curly brackets `{}` to select placeholders.
conditions	UserActionNamingRuleCondition[]	Defines the conditions when the naming rule should apply. Can be `null`.
useOrConditions	boolean	If set to `true` the conditions will be connected by logical OR instead of logical AND. Can be `null`.

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

conditions

UserActionNamingRuleCondition[]

Defines the conditions when the naming rule should apply.

Can be null.

useOrConditions

boolean

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

Can be null.

The `UserActionNamingRuleCondition` object

The settings of conditions for user action naming.

Element Type Description

operand1

string

Element	Type	Description
operand1	string	Must be a defined placeholder wrapped in curly braces
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 Can be `null`.
operator	string	The operator of the condition The element can hold these values `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`

Must be a defined placeholder wrapped in curly braces

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

Can be null.

operator

string

The operator of the condition

The element can hold these values

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

The `MetaDataCapturing` object

Configuration to capture meta data with the JavaScript agent.

Element	Type	Description
type	string	The type of the meta data to capture. The element can hold these values `COOKIE` `CSS_SELECTOR` `JAVA_SCRIPT_FUNCTION` `JAVA_SCRIPT_VARIABLE` `META_TAG` `QUERY_STRING`
capturingName	string	The name of the meta data to capture.
name	string	Name for displaying the captured values in Dynatrace.
uniqueId	integer	The unique id of the meta data to capture. Can be `null`.
publicMetadata	boolean	True if this metadata should be captured regardless of the privacy settings Can be `null`.
useLastValue	boolean	True if the last captured value should be used for this metadata. By default the first value will be used. Can be `null`.

The `ConversionGoal` object

A conversion goal of the application.

Element	Type	Description
name	string	The name of the conversion goal.
id	string	The ID of conversion goal. Omit it while creating a new conversion goal. Can be `null`.
type	string	The type of the conversion goal. The element can hold these values `Destination` `UserAction` `VisitDuration` `VisitNumActions` Can be `null`.
destinationDetails	DestinationDetails	Configuration of a destination-based conversion goal. Can be `null`.
userActionDetails	UserActionDetails	Configuration of a user action-based conversion goal. Can be `null`.
visitDurationDetails	VisitDurationDetails	Configuration of a visit duration-based conversion goal. Can be `null`.
visitNumActionDetails	VisitNumActionDetails	Configuration of a number of user actions-based conversion goal. Can be `null`.

The `DestinationDetails` object

Configuration of a destination-based conversion goal.

Element Type Description

urlOrPath

string

Element	Type	Description
urlOrPath	string	The path to be reached to hit the conversion goal.
matchType	string	The operator of the match. The element can hold these values `Begins` `Contains` `Ends` Can be `null`.
caseSensitive	boolean	The match is case-sensitive (`true`) or (`false`). Can be `null`.

The path to be reached to hit the conversion goal.

matchType

string

The operator of the match.

The element can hold these values

Begins
Contains
Ends

Can be null.

caseSensitive

boolean

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

Can be null.

The `UserActionDetails` object

Configuration of a user action-based conversion goal.

Element	Type	Description
value	string	The value to be matched to hit the conversion goal. Can be `null`.
caseSensitive	boolean	The match is case-sensitive (`true`) or (`false`). Can be `null`.
matchType	string	The operator of the match. The element can hold these values `Begins` `Contains` `Ends` Can be `null`.
matchEntity	string	The type of the entity to which the rule applies. The element can hold these values `ActionName` `CssSelector` `JavaScriptVariable` `MetaTag` `PagePath` `PageTitle` `PageUrl` `UrlAnchor` `XhrUrl` Can be `null`.
actionType	string	Type of the action to which the rule applies. The element can hold these values `Custom` `Load` `Xhr` Can be `null`.

The `VisitDurationDetails` object

Configuration of a visit duration-based conversion goal.

Element	Type	Description
durationInMillis	integer	The duration of session to hit the conversion goal, in milliseconds.

The `VisitNumActionDetails` object

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

Element Type Description

numUserActions

integer

Element	Type	Description
numUserActions	integer	The number of user actions to hit the conversion goal. Can be `null`.

The number of user actions to hit the conversion goal.

Can be null.

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.

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

Response

Response codes

Code	Type	Description
201	EntityShortRepresentation	Success. The response body contains the ID and name of the new web application.
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element Type Description

string

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

The ID of the Dynatrace entity.

name

string

The name of the Dynatrace entity.

Can be null.

description

string

A short description of the Dynatrace entity.

Can be null.

Response body JSON model

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

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

Authentication

To execute this request, you need an access token with Write configuration (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 - POST a web application

Authentication

Parameters

Request body objects

The WebApplicationConfig object

The ConfigurationMetadata object

The SessionReplaySetting object

The Apdex object

The WaterfallSettings object

The MonitoringSettings object

The JavaScriptFrameworkSupport object

The ContentCapture object

The ResourceTimingSettings object

The TimeoutSettings object

The VisuallyComplete2Settings object

The AdvancedJavaScriptTagSettings object

The AdditionalEventHandlers object

The EventWrapperSettings object

The GlobalEventCaptureSettings object

The WebApplicationConfigBrowserRestrictionSettings object

The WebApplicationConfigBrowserRestriction object

The WebApplicationConfigIpAddressRestrictionSettings object

The IpAddressRange object

The JavaScriptInjectionRules object

The UserTag object

The UserActionAndSessionProperties object

The UserActionNamingSettings object

The UserActionNamingPlaceholder object

The UserActionNamingPlaceholderProcessingStep object

The UserActionNamingRule object

The UserActionNamingRuleCondition object

The MetaDataCapturing object

The ConversionGoal object

The DestinationDetails object

The UserActionDetails object

The VisitDurationDetails object

The VisitNumActionDetails 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 `ConfigurationMetadata` object

The `SessionReplaySetting` object

The `Apdex` object

The `WaterfallSettings` object

The `MonitoringSettings` object

The `JavaScriptFrameworkSupport` object

The `ContentCapture` object

The `ResourceTimingSettings` object

The `TimeoutSettings` object

The `VisuallyComplete2Settings` object

The `AdvancedJavaScriptTagSettings` object

The `AdditionalEventHandlers` object

The `EventWrapperSettings` object

The `GlobalEventCaptureSettings` object

The `WebApplicationConfigBrowserRestrictionSettings` object

The `WebApplicationConfigBrowserRestriction` object

The `WebApplicationConfigIpAddressRestrictionSettings` object

The `IpAddressRange` object

The `JavaScriptInjectionRules` object

The `UserTag` object

The `UserActionAndSessionProperties` object

The `UserActionNamingSettings` object

The `UserActionNamingPlaceholder` object

The `UserActionNamingPlaceholderProcessingStep` object

The `UserActionNamingRule` object

The `UserActionNamingRuleCondition` object

The `MetaDataCapturing` object

The `ConversionGoal` object

The `DestinationDetails` object

The `UserActionDetails` object

The `VisitDurationDetails` object

The `VisitNumActionDetails` object

The `EntityShortRepresentation` object