Web application configuration API - GET a web application

Gets parameters of the specified web application.

This API only supports web applications (including agentless applications and browser extensions). Mobile apps, AMP applications and custom applications are not supported.

The request produces an application/json payload.

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

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
id string

The ID of the requested web application.

path required

Response format

The WebApplicationConfig object

Configuration of a web application.

Element Type Description
metadata ConfigurationMetadata
identifier string

Dynatrace entity ID of the web application.

name string

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

type string

The type of the web application.

The type element can hold these values.
realUserMonitoringEnabled boolean

Real user monitoring enabled/disabled.

costControlUserSessionPercentage number

Analize X% of user sessions.

loadActionKeyPerformanceMetric string

The key performance metric of load actions.

The loadActionKeyPerformanceMetric element can hold these values.
xhrActionKeyPerformanceMetric string

The key performance metric of XHR actions.

The xhrActionKeyPerformanceMetric element can hold these values.
loadActionApdexSettings Apdex
xhrActionApdexSettings Apdex
customActionApdexSettings Apdex
waterfallSettings WaterfallSettings
monitoringSettings MonitoringSettings
userTags UserTag[]

User tags settings.

userActionAndSessionProperties UserActionAndSessionProperties[]

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

userActionNamingSettings UserActionNamingSettings
metaDataCaptureSettings MetaDataCapturing[]

Java script agent meta data capture settings.

conversionGoals ConversionGoal[]

A list of conversion goals of the application.

urlInjectionPattern string

Url injection pattern for manual web application.

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.

type string

The type of the conversion goal.

The type element can hold these values.
destinationDetails DestinationDetails
userActionDetails UserActionDetails
visitDurationDetails VisitDurationDetails
visitNumActionDetails VisitNumActionDetails

The VisitNumActionDetails object

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

Element Type Description
numUserActions integer

The number of user actions to hit the conversion goal.

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

caseSensitive boolean

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

matchType string

The operator of the match.

The matchType element can hold these values.
matchEntity string

The type of the entity to which the rule applies.

The matchEntity element can hold these values.
actionType string

Type of the action to which the rule applies.

The actionType element can hold these values.

The DestinationDetails object

Configuration of a destination-based conversion goal.

Element Type Description
urlOrPath string

The path to be reached to hit the conversion goal.

matchType string

The operator of the match.

The matchType element can hold these values.
caseSensitive boolean

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

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 type element can hold these values.
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.

publicMetadata boolean

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

The UserActionNamingSettings object

The settings of user action naming.

Element Type Description
placeholders UserActionNamingPlaceholder[]

User action placeholders.

loadActionNamingRules UserActionNamingRule[]

User action naming rules for loading actions.

xhrActionNamingRules UserActionNamingRule[]

User action naming rules for xhr actions.

customActionNamingRules UserActionNamingRule[]

User action naming rules for custom actions.

ignoreCase boolean

Case insensitive naming.

splitUserActionsByDomain boolean

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

The UserActionNamingRule object

The settings of naming rule.

Element Type Description
template string

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

conditions UserActionNamingRuleCondition[]

Defines the conditions when the naming rule should apply.

The UserActionNamingRuleCondition object

The settings of conditions for user action naming.

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

operator string

The operator of the condition

The operator element can hold these values.

The UserActionNamingPlaceholder object

The placeholder settings.

Element Type Description
name string

Placeholder name.

input string

Input.

The input element can hold these values.
processingPart string

Part.

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

Processing actions.

metadataId integer

Id of the metadata.

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 type element can hold these values.
patternBefore string

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

patternBeforeSearchType string

The required occurrence of patternBefore.

The patternBeforeSearchType element can hold these values.
patternAfter string

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

patternAfterSearchType string

The required occurrence of patternAfter.

The patternAfterSearchType element can hold these values.
replacement string

Replacement for the original value.

patternToReplace string

The pattern to be replaced.

Only applicable if the type is REPLACE_WITH_PATTERN.

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.

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.

The UserActionAndSessionProperties object

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

Element Type Description
displayName string

Display name of the property

type string

Data Type of the property

The type element can hold these values.
origin string

Origin of the property

The origin element can hold these values.
aggregation string

Aggregation of the property

The aggregation element can hold these values.
storeAsUserActionProperty boolean

Set to true, if it's to be stored as a user action property

storeAsSessionProperty boolean

Set to true, if it's to be stored as a session property

cleanupRule string

Cleanup rule of this property

serverSideRequestAttribute string

If the origin is SERVER_SIDE_REQUEST_ATTRIBUTE, UUID of the request attribute

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

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

cleanupRule string

Cleanup rule expression of the userTag

serverSideRequestAttribute string

requestAttribute Id of the userTag

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
contentCapture ContentCapture
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.

injectionMode string

JavaScript injection mode.

The injectionMode element can hold these values.
addCrossOriginAnonymousAttribute boolean

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

scriptTagCacheDurationInHours integer

Time duration for the cache settings.

libraryFileLocation string

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

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

Only supported by auto-injected applications.

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.

Only supported by auto-injected applications.

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
browserRestrictionSettings WebApplicationConfigBrowserRestrictionSettings
ipAddressRestrictionSettings WebApplicationConfigIpAddressRestrictionSettings
javaScriptInjectionRules JavaScriptInjectionRules[]

Java script injection rules.

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 urlOperator element can hold these values.
urlPattern string

The url pattern of the java script injection.

rule string

The url rule of the java script injection.

The rule element can hold these values.
htmlPattern string

The html pattern of the java script injection.

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 mode element can hold these values.
ipAddressRestrictions IpAddressRange[]

The IpAddressRange object

Ip address range that can be specified as single ip address, addresses (from) and address to or address and subnet mask.

Element Type Description
subnetMask integer

The subnet of the ip address range settings

address string

The ip address

addressTo string

The ip address to

The WebApplicationConfigBrowserRestrictionSettings object

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

Element Type Description
mode string

The mode of the list of browser restrictions.

The mode element can hold these values.
browserRestrictions WebApplicationConfigBrowserRestriction[]

A list of browser restrictions.

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.

browserType string

The type of the browser that is used.

The browserType element can hold these values.
platform string

The platform on which the browser is being used.

The platform element can hold these values.
comparator string

Compares different browsers together.

The comparator element can hold these values.

The AdvancedJavaScriptTagSettings object

Advanced JavaScript tag settings.

Element Type Description
syncBeaconFirefox boolean

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

syncBeaconInternetExplorer boolean

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

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
eventWrapperSettings EventWrapperSettings
globalEventCaptureSettings GlobalEventCaptureSettings

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

Settings for content capture.

Element Type Description
resourceTimingSettings ResourceTimingSettings
javaScriptErrors boolean

JavaScript errors monitoring enabled/disabled.

timeoutSettings TimeoutSettings
visuallyCompleteAndSpeedIndex boolean

Visually complete and Speed index support enabled/disabled.

visuallyComplete2Settings VisuallyComplete2Settings

The VisuallyComplete2Settings object

Settings for VisuallyComplete2

Element Type Description
imageUrlBlacklist string

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

mutationBlacklist string

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

mutationTimeout integer

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

inactivityTimeout integer

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

threshold integer

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

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

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 resourceTimingCaptureType element can hold these values.
resourceTimingsDomainLimit integer

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

Only effective if resourceTimingCaptureType is CAPTURE_LIMITED_SUMMARIES.

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

Defines the Apdex settings of an application.

Element Type Description
threshold number
toleratedThreshold integer

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

You can use values between 100 and 60000.

frustratingThreshold integer

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

You can use values between 100 and 240000.

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.

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.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

clusterVersion string

Dynatrace server version.

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_FUNCTION
  • JAVA_SCRIPT_VARIABLE
  • META_TAG
  • QUERY_STRING

Possible values for the operator element in the UserActionNamingRuleCondition object:

  • 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

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:

  • EXTRACT_BY_REGULAR_EXPRESSION
  • REPLACEMENT
  • REPLACE_IDS
  • REPLACE_WITH_PATTERN
  • REPLACE_WITH_REGULAR_EXPRESSION
  • 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
  • TOP_XHR_URL
  • XHR_URL

Possible values for the aggregation element in the UserActionAndSessionProperties object:

  • FIRST
  • LAST

Possible values for the origin element in the UserActionAndSessionProperties object:

  • JAVASCRIPT_API
  • META_DATA
  • SERVER_SIDE_REQUEST_ATTRIBUTE

Possible values for the type element in the UserActionAndSessionProperties object:

  • DATE
  • DOUBLE
  • LONG
  • LONG_STRING
  • STRING

Possible values for the rule element in the JavaScriptInjectionRules object:

  • AFTER_SPECIFIC_HTML
  • AUTOMATIC_INJECTION
  • BEFORE_SPECIFIC_HTML
  • DO_NOT_INJECT

Possible values for the urlOperator element in the JavaScriptInjectionRules object:

  • ALL_PAGES
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH

Possible values for the comparator element in the WebApplicationConfigBrowserRestriction object:

  • EQUALS
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN_OR_EQUAL

Possible values for the platform element in the WebApplicationConfigBrowserRestriction object:

  • ALL
  • DESKTOP
  • MOBILE

Possible values for the browserType element in the WebApplicationConfigBrowserRestriction object:

  • ANDROID_WEBKIT
  • BOTS_SPIDERS
  • CHROME
  • EDGE
  • FIREFOX
  • INTERNET_EXPLORER
  • OPERA
  • SAFARI

Possible values for the mode element in the WebApplicationConfigBrowserRestrictionSettings object:

  • EXCLUDE
  • INCLUDE

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

Possible values for the type element in the WebApplicationConfig object:

  • AUTO_INJECTED
  • BROWSER_EXTENSION_INJECTED
  • MANUALLY_INJECTED