Web application configuration API - GET default application

Gets parameters of the default web application of your Dynatrace environment.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/default
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/web/default

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200WebApplicationConfig

Success

Response body objects

The WebApplicationConfig object

Configuration of a web application.

ElementTypeDescription
conversionGoalsConversionGoal[]

A list of conversion goals of the application.

costControlUserSessionPercentagenumber

Analize X% of user sessions.

customActionApdexSettingsApdex

Defines the Apdex settings of an application.

identifierstring

Dynatrace entity ID of the web application.

loadActionApdexSettingsApdex

Defines the Apdex settings of an application.

loadActionKeyPerformanceMetricstring

The key performance metric of load actions.

  • ACTION_DURATION
  • CUMULATIVE_LAYOUT_SHIFT
  • DOM_INTERACTIVE
  • FIRST_INPUT_DELAY
  • LARGEST_CONTENTFUL_PAINT
  • LOAD_EVENT_END
  • LOAD_EVENT_START
  • RESPONSE_END
  • RESPONSE_START
  • SPEED_INDEX
  • VISUALLY_COMPLETE
metaDataCaptureSettingsMetaDataCapturing[]

Java script agent meta data capture settings.

metadataConfigurationMetadata

Metadata useful for debugging

monitoringSettingsMonitoringSettings

Real user monitoring settings.

namestring

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

realUserMonitoringEnabledboolean

Real user monitoring enabled/disabled.

sessionReplayConfigSessionReplaySetting

Session replay settings

typestring

The type of the web application.

  • AUTO_INJECTED
  • BROWSER_EXTENSION_INJECTED
  • MANUALLY_INJECTED
urlInjectionPatternstring

Url injection pattern for manual web application.

userActionAndSessionPropertiesUserActionAndSessionProperties[]

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

userActionNamingSettingsUserActionNamingSettings

The settings of user action naming.

userTagsUserTag[]

User tags settings.

waterfallSettingsWaterfallSettings

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

xhrActionApdexSettingsApdex

Defines the Apdex settings of an application.

xhrActionKeyPerformanceMetricstring

The key performance metric of XHR actions.

  • ACTION_DURATION
  • RESPONSE_END
  • RESPONSE_START
  • VISUALLY_COMPLETE

The ConversionGoal object

A conversion goal of the application.

ElementTypeDescription
destinationDetailsDestinationDetails

Configuration of a destination-based conversion goal.

idstring

The ID of conversion goal.

Omit it while creating a new conversion goal.

namestring

The name of the conversion goal.

typestring

The type of the conversion goal.

  • Destination
  • UserAction
  • VisitDuration
  • VisitNumActions
userActionDetailsUserActionDetails

Configuration of a user action-based conversion goal.

visitDurationDetailsVisitDurationDetails

Configuration of a visit duration-based conversion goal.

visitNumActionDetailsVisitNumActionDetails

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

The DestinationDetails object

Configuration of a destination-based conversion goal.

ElementTypeDescription
caseSensitiveboolean

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

matchTypestring

The operator of the match.

  • Begins
  • Contains
  • Ends
urlOrPathstring

The path to be reached to hit the conversion goal.

The UserActionDetails object

Configuration of a user action-based conversion goal.

ElementTypeDescription
actionTypestring

Type of the action to which the rule applies.

  • Custom
  • Load
  • Xhr
caseSensitiveboolean

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

matchEntitystring

The type of the entity to which the rule applies.

  • ActionName
  • PageUrl
matchTypestring

The operator of the match.

  • Begins
  • Contains
  • Ends
valuestring

The value to be matched to hit the conversion goal.

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.

The Apdex object

Defines the Apdex settings of an application.

ElementTypeDescription
frustratingFallbackThresholdnumber

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

frustratingThresholdnumber

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

toleratedFallbackThresholdnumber

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

toleratedThresholdnumber

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

The MetaDataCapturing object

Configuration to capture meta data with the Javascript agent. The captured metadata can be referenced by its uniqueId in UserTags, UserActionAndSessionProperties or UserActionNamingPlaceholder

ElementTypeDescription
capturingNamestring

The name of the meta data to capture.

namestring

Name for displaying the captured values in Dynatrace.

publicMetadataboolean

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

typestring

The type of the meta data to capture.

  • COOKIE
  • CSS_SELECTOR
  • JAVA_SCRIPT_FUNCTION
  • JAVA_SCRIPT_VARIABLE
  • META_TAG
  • QUERY_STRING
  • RESPONSE_HEADER
uniqueIdinteger

The unique id of the meta data to capture.

useLastValueboolean

True if the last captured value should be used for this metadata. By default the first value will be used.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The MonitoringSettings object

Real user monitoring settings.

ElementTypeDescription
addCrossOriginAnonymousAttributeboolean

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

advancedJavaScriptTagSettingsAdvancedJavaScriptTagSettings

Advanced JavaScript tag settings.

angularPackageNamestring

The name of the angular package.

browserRestrictionSettingsWebApplicationConfigBrowserRestrictionSettings

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

cacheControlHeaderOptimizationsboolean

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

contentCaptureContentCapture

Settings for content capture.

cookiePlacementDomainstring

Domain for cookie placement.

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.

customConfigurationPropertiesstring

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

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.

fetchRequestsboolean

fetch() request capture enabled/disabled.

injectionModestring

JavaScript injection mode.

  • CODE_SNIPPET
  • CODE_SNIPPET_ASYNC
  • INLINE_CODE
  • JAVASCRIPT_TAG
instrumentedWebServerboolean

Instrumented web or app server.

ipAddressRestrictionSettingsWebApplicationConfigIpAddressRestrictionSettings

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

javaScriptFrameworkSupportJavaScriptFrameworkSupport

Support of various JavaScript frameworks.

javaScriptInjectionRulesJavaScriptInjectionRules[]

Java script injection rules.

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.

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.

sameSiteCookieAttributestring

Same site cookie attribute

  • LAX
  • NONE
  • STRICT
scriptTagCacheDurationInHoursinteger

Time duration for the cache settings.

secureCookieAttributeboolean

Secure attribute usage for Dynatrace cookies enabled/disabled.

serverRequestPathIdstring

Path to identify the server’s request ID.

useCorsboolean

Send beacon data via CORS.

xmlHttpRequestboolean

XmlHttpRequest support enabled/disabled.

The AdvancedJavaScriptTagSettings object

Advanced JavaScript tag settings.

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

instrumentUnsupportedAjaxFrameworksboolean

Instrumentation of unsupported Ajax frameworks enabled/disabled.

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.

proxyWrapperEnabledboolean

Proxy wrapper enabled/disabled.

specialCharactersToEscapestring

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

syncBeaconFirefoxboolean

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

syncBeaconInternetExplorerboolean

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

userActionNameAttributestring

User action name attribute.

The AdditionalEventHandlers object

Additional event handlers and wrappers.

ElementTypeDescription
blurEventHandlerboolean

Blur event handler enabled/disabled.

changeEventHandlerboolean

Change event handler enabled/disabled.

clickEventHandlerboolean

Click event handler enabled/disabled.

maxDomNodesToInstrumentinteger

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

mouseupEventHandlerboolean

Mouseup event handler enabled/disabled.

toStringMethodboolean

toString method enabled/disabled.

userMouseupEventForClicksboolean

Use mouseup event for clicks enabled/disabled.

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
blurboolean

Blur enabled/disabled.

changeboolean

Change enabled/disabled.

clickboolean

Click enabled/disabled.

mouseUpboolean

MouseUp enabled/disabled.

touchEndboolean

TouchEnd enabled/disabled.

touchStartboolean

TouchStart enabled/disabled.

The GlobalEventCaptureSettings object

Global event capture settings.

ElementTypeDescription
additionalEventCapturedAsUserInputstring

Additional events to be captured globally as user input.

For example, DragStart or DragEnd.

changeboolean

Change enabled/disabled.

clickboolean

Click enabled/disabled.

doubleClickboolean

DoubleClick enabled/disabled.

keyDownboolean

KeyDown enabled/disabled.

keyUpboolean

KeyUp enabled/disabled.

mouseDownboolean

MouseDown enabled/disabled.

mouseUpboolean

MouseUp enabled/disabled.

scrollboolean

Scroll enabled/disabled.

touchEndboolean

TouchEnd enabled/disabled.

touchStartboolean

TouchStart enabled/disabled.

The WebApplicationConfigBrowserRestrictionSettings object

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

ElementTypeDescription
browserRestrictionsWebApplicationConfigBrowserRestriction[]

A list of browser restrictions.

modestring

The mode of the list of browser restrictions.

  • EXCLUDE
  • INCLUDE

The WebApplicationConfigBrowserRestriction object

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

ElementTypeDescription
browserTypestring

The type of the browser that is used.

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

The version of the browser that is used.

comparatorstring

Compares different browsers together.

  • EQUALS
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN_OR_EQUAL
platformstring

The platform on which the browser is being used.

  • ALL
  • DESKTOP
  • MOBILE

The ContentCapture object

Settings for content capture.

ElementTypeDescription
javaScriptErrorsboolean

JavaScript errors monitoring enabled/disabled.

resourceTimingSettingsResourceTimingSettings

Settings for resource timings capture.

timeoutSettingsTimeoutSettings

Settings for timed action capture.

visuallyComplete2SettingsVisuallyComplete2Settings

Settings for VisuallyComplete2

visuallyCompleteAndSpeedIndexboolean

Visually complete and Speed index support enabled/disabled.

The ResourceTimingSettings object

Settings for resource timings capture.

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

  • CAPTURE_ALL_SUMMARIES
  • CAPTURE_FULL_DETAILS
  • CAPTURE_LIMITED_SUMMARIES
resourceTimingsDomainLimitinteger

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

Only effective if resourceTimingCaptureType is CAPTURE_LIMITED_SUMMARIES.

w3cResourceTimingsboolean

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

The TimeoutSettings object

Settings for timed action capture.

ElementTypeDescription
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

timedActionSupportboolean

Timed action support enabled/disabled.

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

The VisuallyComplete2Settings object

Settings for VisuallyComplete2

ElementTypeDescription
excludeUrlRegexstring

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

ignoredMutationsListstring

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

inactivityTimeoutinteger

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

mutationTimeoutinteger

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

thresholdinteger

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

The WebApplicationConfigIpAddressRestrictionSettings object

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

ElementTypeDescription
ipAddressRestrictionsIpAddressRange[]-
modestring

The mode of the list of ip address restrictions.

  • EXCLUDE
  • INCLUDE

The IpAddressRange object

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

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

subnetMaskinteger

The subnet mask of the IP address range.

The JavaScriptFrameworkSupport object

Support of various JavaScript frameworks.

ElementTypeDescription
activeXObjectboolean

ActiveXObject detection support enabled/disabled.

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.

The JavaScriptInjectionRules object

Rules for javascript injection

ElementTypeDescription
enabledboolean

The enable or disable rule of the java script injection.

htmlPatternstring

The html pattern of the java script injection.

rulestring

The url rule of the java script injection.

  • AFTER_SPECIFIC_HTML
  • AUTOMATIC_INJECTION
  • BEFORE_SPECIFIC_HTML
  • DO_NOT_INJECT
targetstring

The target against which the rule of the java script injection should be matched.

  • PAGE_QUERY
  • URL
urlOperatorstring

The url operator of the java script injection.

  • ALL_PAGES
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
urlPatternstring

The url pattern of the java script injection.

The SessionReplaySetting object

Session replay settings

ElementTypeDescription
costControlPercentageinteger

Session replay sampling rating in percentage.

cssResourceCapturingExclusionRulesstring[]

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

enableCssResourceCapturingboolean

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

enabledboolean

SessionReplay Enabled.

The UserActionAndSessionProperties object

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

ElementTypeDescription
aggregationstring

The aggregation type of the property.

It defines how multiple values of the property are aggregated.

  • AVERAGE
  • FIRST
  • LAST
  • MAXIMUM
  • MINIMUM
  • SUM
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.

displayNamestring

The display name of the property.

ignoreCaseboolean

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

keystring

Key of the property

longStringLengthinteger

If the type is LONG_STRING, the max length for this property. Must be a multiple of 100. Defaults to 200.

metadataIdinteger

A reference to the uniqueId of a MetadataCapturingConfig.Must be set if "origin" is of type META_DATA.

originstring

The origin of the property

  • JAVASCRIPT_API
  • META_DATA
  • SERVER_SIDE_REQUEST_ATTRIBUTE
serverSideRequestAttributestring

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

storeAsSessionPropertyboolean

If true, the property is stored as a session property

storeAsUserActionPropertyboolean

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

typestring

The data type of the property.

  • DATE
  • DOUBLE
  • LONG
  • LONG_STRING
  • STRING
uniqueIdinteger

Unique id among all userTags and properties of this application

The UserActionNamingSettings object

The settings of user action naming.

ElementTypeDescription
customActionNamingRulesUserActionNamingRule[]

User action naming rules for custom actions.

ignoreCaseboolean

Case insensitive naming.

loadActionNamingRulesUserActionNamingRule[]

User action naming rules for loading actions.

placeholdersUserActionNamingPlaceholder[]

User action placeholders.

queryParameterCleanupsstring[]

List of parameters that should be removed from the query before using the query in the user action name.

splitUserActionsByDomainboolean

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

useFirstDetectedLoadActionboolean

First load action found under an XHR action should be used when true. Else the deepest one under the xhr action is used

xhrActionNamingRulesUserActionNamingRule[]

User action naming rules for xhr actions.

The UserActionNamingRule object

The settings of naming rule.

ElementTypeDescription
conditionsUserActionNamingRuleCondition[]

Defines the conditions when the naming rule should apply.

templatestring

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

useOrConditionsboolean

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

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

operatorstring

The operator of the condition

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

The UserActionNamingPlaceholder object

The placeholder settings.

ElementTypeDescription
inputstring

Input.

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

A reference to the uniqueId of a MetadataCapturingConfig. Must be set if "Input" is of type METADATA.

namestring

Placeholder name.

processingPartstring

Part.

  • ALL
  • ANCHOR
  • PATH
processingStepsUserActionNamingPlaceholderProcessingStep[]

Processing actions.

useGuessedElementIdentifierboolean

Use the element identifier that was selected by Dynatrace.

The UserActionNamingPlaceholderProcessingStep object

The processing step settings.

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

patternAfterstring

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

patternAfterSearchTypestring

The required occurrence of patternAfter.

  • FIRST
  • LAST
patternBeforestring

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

patternBeforeSearchTypestring

The required occurrence of patternBefore.

  • FIRST
  • LAST
patternToReplacestring

The pattern to be replaced.

Only applicable if the type is REPLACE_WITH_PATTERN.

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.

replacementstring

Replacement for the original value.

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.
  • EXTRACT_BY_REGULAR_EXPRESSION
  • REPLACEMENT
  • REPLACE_IDS
  • REPLACE_WITH_PATTERN
  • REPLACE_WITH_REGULAR_EXPRESSION
  • SUBSTRING

The UserTag object

Defines UserTags settings of an application.

ElementTypeDescription
cleanupRulestring

Cleanup rule expression of the userTag

ignoreCaseboolean

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

metadataIdinteger

A reference to the uniqueId of a MetadataCapturingConfig. Must be set if the UserTag is based on metadata captured by the Javascript agent (e.g. a Javascript variable, CSS selector, etc.)

serverSideRequestAttributestring

Serverside request attribute id of the userTag. Must be set if the UserTag is based on a serverside request attribute.

uniqueIdinteger

uniqueId, unique among all userTags and properties of this application

The WaterfallSettings object

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

ElementTypeDescription
resourceBrowserCachingThresholdinteger

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

resourcesThresholdinteger

Warn about resources larger than X bytes.

slowCdnResourcesThresholdinteger

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

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.

speedIndexVisuallyCompleteRatioThresholdinteger

Warn if Speed index exceeds X % of Visually complete.

uncompressedResourcesThresholdinteger

Warn about uncompressed resources larger than X bytes.

Response body JSON model

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