• Home
  • Dynatrace API
  • Configuration
  • RUM
  • Web application configuration
  • Web application
  • POST a web application

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.

POSTManaged 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

ParameterTypeDescriptionInRequired
bodyWebApplicationConfig

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

bodyoptional

Request body objects

The WebApplicationConfig object

Configuration of a web application.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

Can be null.

identifierstring

Dynatrace entity ID of the web application.

Can be null.

namestring

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

typestring

The type of the web application.

The element can hold these values
  • AUTO_INJECTED
  • BROWSER_EXTENSION_INJECTED
  • MANUALLY_INJECTED

Can be null.

realUserMonitoringEnabledboolean

Real user monitoring enabled/disabled.

costControlUserSessionPercentagenumber

Analize X% of user sessions.

loadActionKeyPerformanceMetricstring

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
sessionReplayConfigSessionReplaySetting

Session replay settings

Can be null.

xhrActionKeyPerformanceMetricstring

The key performance metric of XHR actions.

The element can hold these values
  • ACTION_DURATION
  • RESPONSE_END
  • RESPONSE_START
  • VISUALLY_COMPLETE
loadActionApdexSettingsApdex

Defines the Apdex settings of an application.

xhrActionApdexSettingsApdex

Defines the Apdex settings of an application.

customActionApdexSettingsApdex

Defines the Apdex settings of an application.

waterfallSettingsWaterfallSettings

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

monitoringSettingsMonitoringSettings

Real user monitoring settings.

userTagsUserTag[]

User tags settings.

Can be null.

userActionAndSessionPropertiesUserActionAndSessionProperties[]

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

Can be null.

userActionNamingSettingsUserActionNamingSettings

The settings of user action naming.

Can be null.

metaDataCaptureSettingsMetaDataCapturing[]

Java script agent meta data capture settings.

Can be null.

conversionGoalsConversionGoal[]

A list of conversion goals of the application.

Can be null.

urlInjectionPatternstring

Url injection pattern for manual web application.

Can be null.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersionstring

Dynatrace version.

Can be null.

The SessionReplaySetting object

Session replay settings

ElementTypeDescription
enabledboolean

SessionReplay Enabled.

costControlPercentageinteger

Session replay sampling rating in percentage.

enableCssResourceCapturingboolean

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

Can be null.

cssResourceCapturingExclusionRulesstring[]

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

Can be null.

The Apdex object

Defines the Apdex settings of an application.

ElementTypeDescription
toleratedThresholdnumber

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

Can be null.

frustratingThresholdnumber

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

Can be null.

toleratedFallbackThresholdnumber

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

Can be null.

frustratingFallbackThresholdnumber

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.

ElementTypeDescription
uncompressedResourcesThresholdinteger

Warn about uncompressed resources larger than X bytes.

resourcesThresholdinteger

Warn about resources larger than X bytes.

resourceBrowserCachingThresholdinteger

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

slowFirstPartyResourcesThresholdinteger

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

slowThirdPartyResourcesThresholdinteger

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

slowCdnResourcesThresholdinteger

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

speedIndexVisuallyCompleteRatioThresholdinteger

Warn if Speed index exceeds X % of Visually complete.

The MonitoringSettings object

Real user monitoring settings.

ElementTypeDescription
fetchRequestsboolean

fetch() request capture enabled/disabled.

xmlHttpRequestboolean

XmlHttpRequest support enabled/disabled.

javaScriptFrameworkSupportJavaScriptFrameworkSupport

Support of various JavaScript frameworks.

contentCaptureContentCapture

Settings for content capture.

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.

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.

Can be null.

injectionModestring

JavaScript injection mode.

The element can hold these values
  • CODE_SNIPPET
  • CODE_SNIPPET_ASYNC
  • INLINE_CODE
  • JAVASCRIPT_TAG
addCrossOriginAnonymousAttributeboolean

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

Can be null.

scriptTagCacheDurationInHoursinteger

Time duration for the cache settings.

Can be null.

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.

Can be null.

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.

Can be null.

customConfigurationPropertiesstring

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

serverRequestPathIdstring

Path to identify the server’s request ID.

secureCookieAttributeboolean

Secure attribute usage for Dynatrace cookies enabled/disabled.

cookiePlacementDomainstring

Domain for cookie placement.

cacheControlHeaderOptimizationsboolean

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

advancedJavaScriptTagSettingsAdvancedJavaScriptTagSettings

Advanced JavaScript tag settings.

browserRestrictionSettingsWebApplicationConfigBrowserRestrictionSettings

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

Can be null.

ipAddressRestrictionSettingsWebApplicationConfigIpAddressRestrictionSettings

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

Can be null.

javaScriptInjectionRulesJavaScriptInjectionRules[]

Java script injection rules.

Can be null.

angularPackageNamestring

The name of the angular package.

Can be null.

The JavaScriptFrameworkSupport object

Support of various JavaScript frameworks.

ElementTypeDescription
angularboolean

AngularJS and Angular support enabled/disabled.

dojoboolean

Dojo support enabled/disabled.

extJSboolean

ExtJS, Sencha Touch support enabled/disabled.

icefacesboolean

ICEfaces support enabled/disabled.

jQueryboolean

jQuery, Backbone.js support enabled/disabled.

mooToolsboolean

MooTools support enabled/disabled.

prototypeboolean

Prototype support enabled/disabled.

activeXObjectboolean

ActiveXObject detection support enabled/disabled.

The ContentCapture object

Settings for content capture.

ElementTypeDescription
resourceTimingSettingsResourceTimingSettings

Settings for resource timings capture.

javaScriptErrorsboolean

JavaScript errors monitoring enabled/disabled.

timeoutSettingsTimeoutSettings

Settings for timed action capture.

visuallyCompleteAndSpeedIndexboolean

Visually complete and Speed index support enabled/disabled.

visuallyComplete2SettingsVisuallyComplete2Settings

Settings for VisuallyComplete2

Can be null.

The ResourceTimingSettings object

Settings for resource timings capture.

ElementTypeDescription
w3cResourceTimingsboolean

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

nonW3cResourceTimingsboolean

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

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.

resourceTimingCaptureTypestring

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.

resourceTimingsDomainLimitinteger

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.

ElementTypeDescription
timedActionSupportboolean

Timed action support enabled/disabled.

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

temporaryActionLimitinteger

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

temporaryActionTotalTimeoutinteger

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

The VisuallyComplete2Settings object

Settings for VisuallyComplete2

ElementTypeDescription
excludeUrlRegexstring

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

Can be null.

ignoredMutationsListstring

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

Can be null.

mutationTimeoutinteger

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

Can be null.

inactivityTimeoutinteger

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.

thresholdinteger

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.

ElementTypeDescription
syncBeaconFirefoxboolean

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

Can be null.

syncBeaconInternetExplorerboolean

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

Can be null.

instrumentUnsupportedAjaxFrameworksboolean

Instrumentation of unsupported Ajax frameworks enabled/disabled.

specialCharactersToEscapestring

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

maxActionNameLengthinteger

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

maxErrorsToCaptureinteger

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

additionalEventHandlersAdditionalEventHandlers

Additional event handlers and wrappers.

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.

globalEventCaptureSettingsGlobalEventCaptureSettings

Global event capture settings.

userActionNameAttributestring

User action name attribute.

Can be null.

proxyWrapperEnabledboolean

Proxy wrapper enabled/disabled.

Can be null.

The AdditionalEventHandlers object

Additional event handlers and wrappers.

ElementTypeDescription
userMouseupEventForClicksboolean

Use mouseup event for clicks enabled/disabled.

clickEventHandlerboolean

Click event handler enabled/disabled.

mouseupEventHandlerboolean

Mouseup event handler enabled/disabled.

blurEventHandlerboolean

Blur event handler enabled/disabled.

changeEventHandlerboolean

Change event handler enabled/disabled.

toStringMethodboolean

toString method enabled/disabled.

maxDomNodesToInstrumentinteger

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.

ElementTypeDescription
clickboolean

Click enabled/disabled.

mouseUpboolean

MouseUp enabled/disabled.

changeboolean

Change enabled/disabled.

blurboolean

Blur enabled/disabled.

touchStartboolean

TouchStart enabled/disabled.

touchEndboolean

TouchEnd enabled/disabled.

The GlobalEventCaptureSettings object

Global event capture settings.

ElementTypeDescription
mouseUpboolean

MouseUp enabled/disabled.

mouseDownboolean

MouseDown enabled/disabled.

clickboolean

Click enabled/disabled.

doubleClickboolean

DoubleClick enabled/disabled.

keyUpboolean

KeyUp enabled/disabled.

keyDownboolean

KeyDown enabled/disabled.

scrollboolean

Scroll enabled/disabled.

additionalEventCapturedAsUserInputstring

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.

ElementTypeDescription
modestring

The mode of the list of browser restrictions.

The element can hold these values
  • EXCLUDE
  • INCLUDE
browserRestrictionsWebApplicationConfigBrowserRestriction[]

A list of browser restrictions.

Can be null.

The WebApplicationConfigBrowserRestriction object

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

ElementTypeDescription
browserVersionstring

The version of the browser that is used.

Can be null.

browserTypestring

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
platformstring

The platform on which the browser is being used.

The element can hold these values
  • ALL
  • DESKTOP
  • MOBILE

Can be null.

comparatorstring

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.

ElementTypeDescription
modestring

The mode of the list of ip address restrictions.

The element can hold these values
  • EXCLUDE
  • INCLUDE
ipAddressRestrictionsIpAddressRange[]-

Can be null.

The IpAddressRange object

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

ElementTypeDescription
subnetMaskinteger

The subnet mask of the IP address range.

Can be null.

addressstring

The IP address to be mapped.

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

addressTostring

The to address of the IP address range.

Can be null.

The JavaScriptInjectionRules object

Rules for javascript injection

ElementTypeDescription
enabledboolean

The enable or disable rule of the java script injection.

urlOperatorstring

The url operator of the java script injection.

The element can hold these values
  • ALL_PAGES
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
urlPatternstring

The url pattern of the java script injection.

Can be null.

rulestring

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
htmlPatternstring

The html pattern of the java script injection.

Can be null.

targetstring

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.

ElementTypeDescription
uniqueIdinteger

uniqueId, unique among all userTags and properties of this application

metadataIdinteger

If it's of type metaData, metaData id of the userTag

Can be null.

cleanupRulestring

Cleanup rule expression of the userTag

Can be null.

serverSideRequestAttributestring

requestAttribute Id of the userTag

Can be null.

ignoreCaseboolean

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.

ElementTypeDescription
displayNamestring

The display name of the property.

Can be null.

typestring

The data type of the property.

The element can hold these values
  • DATE
  • DOUBLE
  • LONG
  • LONG_STRING
  • STRING
originstring

The origin of the property

The element can hold these values
  • JAVASCRIPT_API
  • META_DATA
  • SERVER_SIDE_REQUEST_ATTRIBUTE
aggregationstring

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.

storeAsUserActionPropertyboolean

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

Can be null.

storeAsSessionPropertyboolean

If true, the property is stored as a session property

Can be null.

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.

Can be null.

serverSideRequestAttributestring

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

Can be null.

uniqueIdinteger

Unique id among all userTags and properties of this application

keystring

Key of the property

metadataIdinteger

If the origin is META_DATA, metaData id of the property

Can be null.

ignoreCaseboolean

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

Can be null.

longStringLengthinteger

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.

ElementTypeDescription
placeholdersUserActionNamingPlaceholder[]

User action placeholders.

Can be null.

loadActionNamingRulesUserActionNamingRule[]

User action naming rules for loading actions.

Can be null.

xhrActionNamingRulesUserActionNamingRule[]

User action naming rules for xhr actions.

Can be null.

customActionNamingRulesUserActionNamingRule[]

User action naming rules for custom actions.

Can be null.

ignoreCaseboolean

Case insensitive naming.

Can be null.

useFirstDetectedLoadActionboolean

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.

splitUserActionsByDomainboolean

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

Can be null.

queryParameterCleanupsstring[]

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.

ElementTypeDescription
namestring

Placeholder name.

inputstring

Input.

The element can hold these values
  • ELEMENT_IDENTIFIER
  • INPUT_TYPE
  • METADATA
  • PAGE_TITLE
  • PAGE_URL
  • SOURCE_URL
  • TOP_XHR_URL
  • XHR_URL
processingPartstring

Part.

The element can hold these values
  • ALL
  • ANCHOR
  • PATH
processingStepsUserActionNamingPlaceholderProcessingStep[]

Processing actions.

Can be null.

metadataIdinteger

Id of the metadata.

Can be null.

useGuessedElementIdentifierboolean

Use the element identifier that was selected by Dynatrace.

The UserActionNamingPlaceholderProcessingStep object

The processing step settings.

ElementTypeDescription
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.
The element can hold these values
  • EXTRACT_BY_REGULAR_EXPRESSION
  • REPLACEMENT
  • REPLACE_IDS
  • REPLACE_WITH_PATTERN
  • REPLACE_WITH_REGULAR_EXPRESSION
  • SUBSTRING
patternBeforestring

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

Can be null.

patternBeforeSearchTypestring

The required occurrence of patternBefore.

The element can hold these values
  • FIRST
  • LAST

Can be null.

patternAfterstring

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

Can be null.

patternAfterSearchTypestring

The required occurrence of patternAfter.

The element can hold these values
  • FIRST
  • LAST

Can be null.

replacementstring

Replacement for the original value.

Can be null.

patternToReplacestring

The pattern to be replaced.

Only applicable if the type is REPLACE_WITH_PATTERN.

Can be null.

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.

Can be null.

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.

Can be null.

The UserActionNamingRule object

The settings of naming rule.

ElementTypeDescription
templatestring

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

conditionsUserActionNamingRuleCondition[]

Defines the conditions when the naming rule should apply.

Can be null.

useOrConditionsboolean

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.

ElementTypeDescription
operand1string

Must be a defined placeholder wrapped in curly braces

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

Can be null.

operatorstring

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.

ElementTypeDescription
typestring

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
capturingNamestring

The name of the meta data to capture.

namestring

Name for displaying the captured values in Dynatrace.

uniqueIdinteger

The unique id of the meta data to capture.

Can be null.

publicMetadataboolean

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

Can be null.

useLastValueboolean

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.

ElementTypeDescription
namestring

The name of the conversion goal.

idstring

The ID of conversion goal.

Omit it while creating a new conversion goal.

Can be null.

typestring

The type of the conversion goal.

The element can hold these values
  • Destination
  • UserAction
  • VisitDuration
  • VisitNumActions

Can be null.

destinationDetailsDestinationDetails

Configuration of a destination-based conversion goal.

Can be null.

userActionDetailsUserActionDetails

Configuration of a user action-based conversion goal.

Can be null.

visitDurationDetailsVisitDurationDetails

Configuration of a visit duration-based conversion goal.

Can be null.

visitNumActionDetailsVisitNumActionDetails

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

Can be null.

The DestinationDetails object

Configuration of a destination-based conversion goal.

ElementTypeDescription
urlOrPathstring

The path to be reached to hit the conversion goal.

matchTypestring

The operator of the match.

The element can hold these values
  • Begins
  • Contains
  • Ends

Can be null.

caseSensitiveboolean

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

Can be null.

The UserActionDetails object

Configuration of a user action-based conversion goal.

ElementTypeDescription
valuestring

The value to be matched to hit the conversion goal.

Can be null.

caseSensitiveboolean

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

Can be null.

matchTypestring

The operator of the match.

The element can hold these values
  • Begins
  • Contains
  • Ends

Can be null.

matchEntitystring

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.

actionTypestring

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.

ElementTypeDescription
durationInMillisinteger

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

The VisitNumActionDetails object

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

ElementTypeDescription
numUserActionsinteger

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

CodeTypeDescription
201EntityShortRepresentation

Success. The response body contains the ID and name of the new web application.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

Can be null.

descriptionstring

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.

POSTManaged 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

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid.