Web application configuration API - PUT default application

Updates the default web application of your Dynatrace environment.

The request consumes an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/default
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default

Parameters

Parameter Type Description In Required
body WebApplicationConfig

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

body optional

The WebApplicationConfig object

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
identifier string

Dynatrace entity ID of the web application.

optional
name string

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

required
realUserMonitoringEnabled boolean

Real user monitoring enabled/disabled.

required
costControlUserSessionPercentage number

Analize X% of user sessions.

required
loadActionKeyPerformanceMetric string

The key performance metric of load actions.

The loadActionKeyPerformanceMetric element can hold these values.
required
xhrActionKeyPerformanceMetric string

The key performance metric of XHR actions.

The xhrActionKeyPerformanceMetric element can hold these values.
required
loadActionApdexSettings Apdex

The Apdex settings of load actions.

required
xhrActionApdexSettings Apdex

The Apdex settings of XHR actions.

required
customActionApdexSettings Apdex

The Apdex settings of custom actions.

required
waterfallSettings WaterfallSettings

Content resource settings.

required
monitoringSettings MonitoringSettings

Real user monitoring settings.

required
userActionNamingSettings UserActionNamingSettings

User action naming settings.

optional
metaDataCaptureSettings MetaDataCapturing[]

Java script agent meta data capture settings.

optional
conversionGoals ConversionGoal[]

Conversion goals settings

optional

The ConversionGoal object

Element Type Description Required
name string

Name of the conversion goal

required
id string

ID of conversion goal. Must be null for new conversion goals.

optional
type string

Type of the conversion goal eg on which ruleset it is defined

The type element can hold these values.
optional
destinationDetails DestinationDetails

Settings for destination based conversion goals

optional
userActionDetails UserActionDetails

Settings for action based conversion goals

optional
visitDurationDetails VisitDurationDetails

Settings for duration based conversion goals

optional
visitNumActionDetails VisitNumActionDetails

Settings for action number based conversion goals

optional

The VisitNumActionDetails object

Element Type Description Required
numUserActions integer

Specifies minimum number of actions after which conversion goals is hit

optional

The VisitDurationDetails object

Element Type Description Required
durationInMillis integer

Specify the duration of the visit after which conversion goal is hit

required

The UserActionDetails object

Element Type Description Required
value string

Value to match

optional
caseSensitive boolean

Consider cased during the match

optional
matchType string

Match type

The matchType element can hold these values.
optional
matchEntity string

Entity type on which matching will be performed

The matchEntity element can hold these values.
optional
actionType string

Type of the action for the match

The actionType element can hold these values.
optional

The DestinationDetails object

Element Type Description Required
urlOrPath string

Path or url to match in order to hit conversion goal

required
matchType string

Type of match

The matchType element can hold these values.
optional
caseSensitive boolean

Specify whether the url match is case sensitive

optional

The MetaDataCapturing object

Configuration to capture meta data with the JavaScript agent.

Element Type Description Required
type string

The type of the meta data to capture.

The type element can hold these values.
required
capturingName string

The name of the meta data to capture.

required
name string

Name for displaying the captured values in Dynatrace.

required

The UserActionNamingSettings object

The settings of user action naming.

Element Type Description Required
placeholders UserActionNamingPlaceholder[]

User action placeholders.

optional
loadActionNamingRules UserActionNamingRule[]

User action naming rules for loading actions.

optional
xhrActionNamingRules UserActionNamingRule[]

User action naming rules for xhr actions.

optional
ignoreCase boolean

Case insensitive naming.

optional

The UserActionNamingRule object

The settings of naming rule.

Element Type Description Required
template string

Naming pattern. Use { } to select placeholders.

required
conditions UserActionNamingRuleCondition[]

Define the conditions when this naming rule should apply.

optional

The UserActionNamingRuleCondition object

The settings of conditions for user action naming.

Element Type Description Required
operand1 string required
operand2 string optional
operator string The operator element can hold these values. required

The UserActionNamingPlaceholder object

The placeholder settings.

Element Type Description Required
name string

Placeholder name.

required
input string

Input.

The input element can hold these values.
required
processingPart string

Part.

The processingPart element can hold these values.
required
processingSteps UserActionNamingPlaceholderProcessingStep[]

Processing actions.

optional
metadataId integer

Id of the metadata.

optional
useGuessedElementIdentifier boolean

Use the element identifier that was selected by Dynatrace.

required

The UserActionNamingPlaceholderProcessingStep object

The processing step settings.

Element Type Description Required
type string

Action.

The type element can hold these values.
required
patternBefore string

Before (to be removed).

optional
patternBeforeSearchType string

If patternBefore should be the first or the last occurrence

The patternBeforeSearchType element can hold these values.
optional
patternAfter string

After (to be removed).

optional
patternAfterSearchType string

If patternAfter should be the first or the last occurrence

The patternAfterSearchType element can hold these values.
optional
replacement string

Replace with.

optional

The MonitoringSettings object

Real user monitoring settings.

Element Type Description Required
fetchRequests boolean

fetch() request capture enabled/disabled.

required
xmlHttpRequest boolean

XmlHttpRequest support enabled/disabled.

required
javaScriptFrameworkSupport JavaScriptFrameworkSupport

Support of various JavaScript frameworks.

required
contentCapture ContentCapture

Content capture settings.

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
injectionMode string

JavaScript injection mode.

The injectionMode element can hold these values.
required
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
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
customConfigurationProperties string

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

required
serverRequestPathId string

Path to identify the server’s request ID.

required
secureCookieAttribute boolean

Secure attribute usage for Dynatrace cookies enabled/disabled.

required
cookiePlacementDomain string

Domain for cookie placement.

required
cacheControlHeaderOptimizations boolean

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

required
advancedJavaScriptTagSettings AdvancedJavaScriptTagSettings

Advanced JavaScript tag settings.

required

The AdvancedJavaScriptTagSettings object

Advanced JavaScript tag settings.

Element Type Description Required
syncBeaconFirefox boolean

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

required
syncBeaconInternetExplorer boolean

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

required
instrumentUnsupportedAjaxFrameworks boolean

Instrumentation of unsupported Ajax frameworks enabled/disabled.

required
specialCharactersToEscape string

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

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
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

The GlobalEventCaptureSettings object

Global event capture settings.

Element Type Description Required
mouseUp boolean

MouseUp enabled/disabled.

required
mouseDown boolean

MouseDown enabled/disabled.

required
click boolean

Click enabled/disabled.

required
doubleClick boolean

DoubleClick enabled/disabled.

required
keyUp boolean

KeyUp enabled/disabled.

required
keyDown boolean

KeyDown enabled/disabled.

required
scroll boolean

Scroll enabled/disabled.

required
additionalEventCapturedAsUserInput string

Additional events to be captured globally as user input.

For example, DragStart or DragEnd.

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
click boolean

Click enabled/disabled.

required
mouseUp boolean

MouseUp enabled/disabled.

required
change boolean

Change enabled/disabled.

required
blur boolean

Blur enabled/disabled.

required
touchStart boolean

TouchStart enabled/disabled.

required
touchEnd boolean

TouchEnd enabled/disabled.

required

The AdditionalEventHandlers object

Additional event handlers and wrappers.

Element Type Description Required
userMouseupEventForClicks boolean

Use mouseup event for clicks enabled/disabled.

required
clickEventHandler boolean

Click event handler enabled/disabled.

required
mouseupEventHandler boolean

Mouseup event handler enabled/disabled.

required
blurEventHandler boolean

Blur event handler enabled/disabled.

required
changeEventHandler boolean

Change event handler enabled/disabled.

required
toStringMethod boolean

toString method enabled/disabled.

required
maxDomNodesToInstrument integer

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

required

The ContentCapture object

Settings for content capture.

Element Type Description Required
resourceTimingSettings ResourceTimingSettings

Settings for resource timings capture.

required
javaScriptErrors boolean

JavaScript errors monitoring enabled/disabled.

required
timeoutSettings TimeoutSettings

Settings for timed action capture.

required
visuallyCompleteAndSpeedIndex boolean

Visually complete and Speed index support enabled/disabled.

required

The TimeoutSettings object

Settings for timed action capture.

Element Type Description Required
timedActionSupport boolean

Timed action support enabled/disabled.

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

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

The ResourceTimingSettings object

Settings for resource timings capture.

Element Type Description Required
w3cResourceTimings boolean

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

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.

The resourceTimingCaptureType element can hold these values.
required
resourceTimingsDomainLimit integer

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

Only effective if resourceTimingCaptureType is CAPTURE_LIMITED_SUMMARIES.

required

The JavaScriptFrameworkSupport object

Support of various JavaScript frameworks.

Element Type Description 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
activeXObject boolean

ActiveXObject detection support enabled/disabled.

required

The WaterfallSettings object

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

Element Type Description Required
uncompressedResourcesThreshold integer

Warn about uncompressed resources larger than X bytes.

required
resourcesThreshold integer

Warn about resources larger than X bytes.

required
resourceBrowserCachingThreshold integer

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

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
slowCdnResourcesThreshold integer

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

required
speedIndexVisuallyCompleteRatioThreshold integer

Warn if Speed index exceeds X % of Visually complete.

required

The Apdex object

Defines the Apdex settings of an application.

Element Type Description Required
toleratedThreshold integer

Maximal length of an action, in milliseconds, which is considered as satisfied user experience.

You can use values between 100 and 60000.

optional
frustratingThreshold integer

Maximal length of an action, in milliseconds, which is considered as tolerable user experience.

You can use values between 100 and 240000.

optional
toleratedFallbackThreshold integer

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

Values between 100 and 60000 are allowed.

optional
frustratingFallbackThreshold integer

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

Values between 100 and 240000 are allowed.

optional
considerJavaScriptErrors boolean

Consider JavaScript errors in Apdex calculations enabled/disabled

required

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the actionType element in the UserActionDetails object:

  • Custom
  • Load
  • Xhr

Possible values for the matchEntity element in the UserActionDetails object:

  • ActionName
  • CssSelector
  • JavaScriptVariable
  • MetaTag
  • PagePath
  • PageTitle
  • PageUrl
  • UrlAnchor
  • XhrUrl

Possible values for the matchType element in the DestinationDetails object:

  • Begins
  • Contains
  • Ends

Possible values for the type element in the ConversionGoal object:

  • Destination
  • UserAction
  • VisitDuration
  • VisitNumActions

Possible values for the type element in the MetaDataCapturing object:

  • COOKIE
  • CSS_SELECTOR
  • JAVA_SCRIPT_VARIABLE
  • META_TAG

Possible values for the operator element in the UserActionNamingRuleCondition object:

  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • IS_EMPTY
  • IS_NOT_EMPTY
  • NOT_CONTAINS
  • NOT_ENDS_WITH
  • NOT_EQUALS
  • NOT_STARTS_WITH
  • STARTS_WITH

Possible values for the patternAfterSearchType element in the UserActionNamingPlaceholderProcessingStep object:

  • FIRST
  • LAST

Possible values for the patternBeforeSearchType element in the UserActionNamingPlaceholderProcessingStep object:

  • FIRST
  • LAST

Possible values for the type element in the UserActionNamingPlaceholderProcessingStep object:

  • REPLACEMENT
  • SUBSTRING

Possible values for the processingPart element in the UserActionNamingPlaceholder object:

  • ALL
  • ANCHOR
  • PATH

Possible values for the input element in the UserActionNamingPlaceholder object:

  • ELEMENT_IDENTIFIER
  • INPUT_TYPE
  • METADATA
  • PAGE_TITLE
  • PAGE_URL
  • SOURCE_URL
  • XHR_URL

Possible values for the injectionMode element in the MonitoringSettings object:

  • CODE_SNIPPET
  • CODE_SNIPPET_ASYNC
  • INLINE_CODE
  • JAVASCRIPT_TAG

Possible values for the resourceTimingCaptureType element in the ResourceTimingSettings object:

  • CAPTURE_ALL_SUMMARIES
  • CAPTURE_FULL_DETAILS
  • CAPTURE_LIMITED_SUMMARIES

Possible values for the xhrActionKeyPerformanceMetric element in the WebApplicationConfig object:

  • ACTION_DURATION
  • RESPONSE_END
  • RESPONSE_START
  • VISUALLY_COMPLETE

Possible values for the loadActionKeyPerformanceMetric element in the WebApplicationConfig object:

  • ACTION_DURATION
  • DOM_INTERACTIVE
  • LOAD_EVENT_END
  • LOAD_EVENT_START
  • RESPONSE_END
  • RESPONSE_START
  • SPEED_INDEX
  • VISUALLY_COMPLETE

Response format

A successful request doesn't return any content.

Response codes

Code Description
204 Success. Configuration has been updated. Response doesn't have a body.
400 Failed. The input is invalid.

Validate payload

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

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/default/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default/validator

Response codes

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