Web application configuration API - POST a web application
Creates a new web application.
This API only supports web applications (including agentless applications and browser extensions). For mobile apps and custom applications, see Mobile and custom app API.
The request consumes and produces an application/json
payload.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/web |
Authentication
To execute this request, you need an access token with Write configuration (WriteConfig
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | Web | JSON body of the request, containing parameters of the new web application configuraiton. | body | optional |
Request body objects
The WebApplicationConfig
object
Configuration of a web application.
Element | Type | Description |
---|---|---|
metadata | Configuration | Metadata useful for debugging Can be |
identifier | string | Dynatrace entity ID of the web application. Can be |
name | string | The name of the web application, displayed in the UI. |
type | string | The type of the web application. Can be |
realUserMonitoringEnabled | boolean | Real user monitoring enabled/disabled. |
costControlUserSessionPercentage | number | Analize X% of user sessions. |
loadActionKeyPerformanceMetric | string | The key performance metric of load actions. |
sessionReplayConfig | Session | Session replay settings Can be |
xhrActionKeyPerformanceMetric | string | The key performance metric of XHR actions. |
loadActionApdexSettings | Apdex | Defines the Apdex settings of an application. |
xhrActionApdexSettings | Apdex | Defines the Apdex settings of an application. |
customActionApdexSettings | Apdex | Defines the Apdex settings of an application. |
waterfallSettings | Waterfall | These settings influence the monitoring data you receive for 3rd party, CDN, and 1st party resources. |
monitoringSettings | Monitoring | Real user monitoring settings. |
userTags | User | User tags settings. Can be |
userActionAndSessionProperties | User | User action and session properties settings. Empty List means no change Can be |
userActionNamingSettings | User | The settings of user action naming. Can be |
metaDataCaptureSettings | Meta | Java script agent meta data capture settings. Can be |
conversionGoals | Conversion | A list of conversion goals of the application. Can be |
urlInjectionPattern | string | Url injection pattern for manual web application. Can be |
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. Can be |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. Can be |
clusterVersion | string | Dynatrace version. Can be |
The SessionReplaySetting
object
Session replay settings
Element | Type | Description |
---|---|---|
enabled | boolean | SessionReplay Enabled. |
costControlPercentage | integer | Session replay sampling rating in percentage. |
enableCssResourceCapturing | boolean | Capture ( Can be |
cssResourceCapturingExclusionRules | string[] | A list of URLs to be excluded from CSS resource capturing. Can be |
The Apdex
object
Defines the Apdex settings of an application.
Element | Type | Description |
---|---|---|
toleratedThreshold | number | Maximal value of apdex, which is considered as satisfied user experience. Can be |
frustratingThreshold | number | Maximal value of apdex, which is considered as tolerable user experience. Can be |
toleratedFallbackThreshold | number | Fallback threshold of an XHR action, defining a satisfied user experience, when the configured KPM is not available. Can be |
frustratingFallbackThreshold | number | Fallback threshold of an XHR action, defining a tolerable user experience, when the configured KPM is not available. Can be |
The WaterfallSettings
object
These settings influence the monitoring data you receive for 3rd party, CDN, and 1st party resources.
Element | Type | Description |
---|---|---|
uncompressedResourcesThreshold | integer | Warn about uncompressed resources larger than X bytes. |
resourcesThreshold | integer | Warn about resources larger than X bytes. |
resourceBrowserCachingThreshold | integer | Warn about resources with a lower browser cache rate above X%. |
slowFirstPartyResourcesThreshold | integer | Warn about slow 1st party resources with a response time above X ms. |
slowThirdPartyResourcesThreshold | integer | Warn about slow 3rd party resources with a response time above X ms. |
slowCdnResourcesThreshold | integer | Warn about slow CDN resources with a response time above X ms. |
speedIndexVisuallyCompleteRatioThreshold | integer | Warn if Speed index exceeds X % of Visually complete. |
The MonitoringSettings
object
Real user monitoring settings.
Element | Type | Description |
---|---|---|
fetchRequests | boolean |
|
xmlHttpRequest | boolean |
|
javaScriptFrameworkSupport | Java | Support of various JavaScript frameworks. |
contentCapture | Content | Settings for content capture. |
excludeXhrRegex | string | You can exclude some actions from becoming XHR actions. Put a regular expression, matching all the required URLs, here. If noting specified the feature is disabled. |
correlationHeaderInclusionRegex | string | To enable RUM for XHR calls to AWS Lambda, define a regular expression matching these calls, Dynatrace can then automatically add a custom header (x-dtc) to each such request to the respective endpoints in AWS. Important: These endpoints must accept the x-dtc header, or the requests will fail. Can be |
injectionMode | string | JavaScript injection mode. |
addCrossOriginAnonymousAttribute | boolean | Add the cross origin = anonymous attribute to capture JavaScript error messages and W3C resource timings. Can be |
scriptTagCacheDurationInHours | integer | Time duration for the cache settings. Can be |
libraryFileLocation | string | The location of your application’s custom JavaScript library file. If nothing specified the root directory of your web server is used. Required for auto-injected applications, not supported by agentless applications. Can be |
monitoringDataPath | string | The location to send monitoring data from the JavaScript tag. Specify either a relative or an absolute URL. If you use an absolute URL, data will be sent using CORS. Required for auto-injected applications, optional for agentless applications. Can be |
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 | Advanced | Advanced JavaScript tag settings. |
browserRestrictionSettings | Web | Settings for restricting certain browser type, version, platform and, comparator. It also restricts the mode. Can be |
ipAddressRestrictionSettings | Web | Settings for restricting certain ip addresses and for introducing subnet mask. It also restricts the mode. Can be |
javaScriptInjectionRules | Java | Java script injection rules. Can be |
angularPackageName | string | The name of the angular package. Can be |
The JavaScriptFrameworkSupport
object
Support of various JavaScript frameworks.
Element | Type | Description |
---|---|---|
angular | boolean | AngularJS and Angular support enabled/disabled. |
dojo | boolean | Dojo support enabled/disabled. |
extJS | boolean | ExtJS, Sencha Touch support enabled/disabled. |
icefaces | boolean | ICEfaces support enabled/disabled. |
jQuery | boolean | jQuery, Backbone.js support enabled/disabled. |
mooTools | boolean | MooTools support enabled/disabled. |
prototype | boolean | Prototype support enabled/disabled. |
activeXObject | boolean | ActiveXObject detection support enabled/disabled. |
The ContentCapture
object
Settings for content capture.
Element | Type | Description |
---|---|---|
resourceTimingSettings | Resource | Settings for resource timings capture. |
javaScriptErrors | boolean | JavaScript errors monitoring enabled/disabled. |
timeoutSettings | Timeout | Settings for timed action capture. |
visuallyCompleteAndSpeedIndex | boolean | Visually complete and Speed index support enabled/disabled. |
visuallyComplete2Settings | Visually | Settings for VisuallyComplete2 Can be |
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. Can be |
resourceTimingsDomainLimit | integer | Limits the number of domains for which W3C resource timings are captured. Only effective if resourceTimingCaptureType is Can be |
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 VisuallyComplete2Settings
object
Settings for VisuallyComplete2
Element | Type | Description |
---|---|---|
excludeUrlRegex | string | A RegularExpression used to exclude images and iframes from being detected by the VC module. Can be |
ignoredMutationsList | string | Query selector for mutation nodes to ignore in VC and SI calculation Can be |
mutationTimeout | integer | Determines the time in ms VC waits after an action closes to start calculation. Defaults to 50. Can be |
inactivityTimeout | integer | The time in ms the VC module waits for no mutations happening on the page after the load action. Defaults to 1000. Can be |
threshold | integer | Minimum visible area in pixels of elements to be counted towards VC and SI. Defaults to 50. Can be |
The AdvancedJavaScriptTagSettings
object
Advanced JavaScript tag settings.
Element | Type | Description |
---|---|---|
syncBeaconFirefox | boolean | Send the beacon signal as a synchronous XMLHttpRequest using Firefox enabled/disabled. Can be |
syncBeaconInternetExplorer | boolean | Send the beacon signal as a synchronous XMLHttpRequest using Internet Explorer enabled/disabled. Can be |
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 | Additional | Additional event handlers and wrappers. |
eventWrapperSettings | Event | In addition to the event handlers, events called using |
globalEventCaptureSettings | Global | Global event capture settings. |
userActionNameAttribute | string | User action name attribute. Can be |
proxyWrapperEnabled | boolean | Proxy wrapper enabled/disabled. Can be |
The AdditionalEventHandlers
object
Additional event handlers and wrappers.
Element | Type | Description |
---|---|---|
userMouseupEventForClicks | boolean | Use mouseup event for clicks enabled/disabled. |
clickEventHandler | boolean | Click event handler enabled/disabled. |
mouseupEventHandler | boolean | Mouseup event handler enabled/disabled. |
blurEventHandler | boolean | Blur event handler enabled/disabled. |
changeEventHandler | boolean | Change event handler enabled/disabled. |
toStringMethod | boolean | toString method enabled/disabled. |
maxDomNodesToInstrument | integer | Max. number of DOM nodes to instrument. Valid values range from 0 to 100000. |
The EventWrapperSettings
object
In addition to the event handlers, events called using addEventListener
or attachEvent
can be captured. Be careful with this option! Event wrappers can conflict with the JavaScript code on a web page.
Element | Type | Description |
---|---|---|
click | boolean | Click enabled/disabled. |
mouseUp | boolean | MouseUp enabled/disabled. |
change | boolean | Change enabled/disabled. |
blur | boolean | Blur enabled/disabled. |
touchStart | boolean | TouchStart enabled/disabled. |
touchEnd | boolean | TouchEnd enabled/disabled. |
The GlobalEventCaptureSettings
object
Global event capture settings.
Element | Type | Description |
---|---|---|
mouseUp | boolean | MouseUp enabled/disabled. |
mouseDown | boolean | MouseDown enabled/disabled. |
click | boolean | Click enabled/disabled. |
doubleClick | boolean | DoubleClick enabled/disabled. |
keyUp | boolean | KeyUp enabled/disabled. |
keyDown | boolean | KeyDown enabled/disabled. |
scroll | boolean | Scroll enabled/disabled. |
additionalEventCapturedAsUserInput | string | Additional events to be captured globally as user input. For example, DragStart or DragEnd. |
The WebApplicationConfigBrowserRestrictionSettings
object
Settings for restricting certain browser type, version, platform and, comparator. It also restricts the mode.
Element | Type | Description |
---|---|---|
mode | string | The mode of the list of browser restrictions. |
browserRestrictions | Web | A list of browser restrictions. Can be |
The WebApplicationConfigBrowserRestriction
object
Browser exclusion rules for the browsers that are to be excluded.
Element | Type | Description |
---|---|---|
browserVersion | string | The version of the browser that is used. Can be |
browserType | string | The type of the browser that is used. |
platform | string | The platform on which the browser is being used. Can be |
comparator | string | Compares different browsers together. Can be |
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. |
ipAddressRestrictions | Ip | - Can be |
The IpAddressRange
object
The IP address or the IP address range to be mapped to the location.
Element | Type | Description |
---|---|---|
subnetMask | integer | The subnet mask of the IP address range. Can be |
address | string | The IP address to be mapped. For an IP address range, this is the from address. |
addressTo | string | The to address of the IP address range. Can be |
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. |
urlPattern | string | The url pattern of the java script injection. Can be |
rule | string | The url rule of the java script injection. |
htmlPattern | string | The html pattern of the java script injection. Can be |
target | string | The target against which the rule of the java script injection should be matched. Can be |
The UserTag
object
Defines UserTags settings of an application.
Element | Type | Description |
---|---|---|
uniqueId | integer | uniqueId, unique among all userTags and properties of this application |
metadataId | integer | If it's of type metaData, metaData id of the userTag Can be |
cleanupRule | string | Cleanup rule expression of the userTag Can be |
serverSideRequestAttribute | string | requestAttribute Id of the userTag Can be |
ignoreCase | boolean | If true, the value of this tag will always be stored in lower case. Defaults to false. Can be |
The UserActionAndSessionProperties
object
Defines userAction and session custom defined properties settings of an application.
Element | Type | Description |
---|---|---|
displayName | string | The display name of the property. Can be |
type | string | The data type of the property. |
origin | string | The origin of the property |
aggregation | string | The aggregation type of the property. It defines how multiple values of the property are aggregated. Can be |
storeAsUserActionProperty | boolean | If Can be |
storeAsSessionProperty | boolean | If Can be |
cleanupRule | string | The cleanup rule of the property. Defines how to extract the data you need from a string value. Specify the regular expression for the data you need there. Can be |
serverSideRequestAttribute | string | The ID of the request attribute. Only applicable when the origin is set to Can be |
uniqueId | integer | Unique id among all userTags and properties of this application |
key | string | Key of the property |
metadataId | integer | If the origin is META_DATA, metaData id of the property Can be |
ignoreCase | boolean | If true, the value of this property will always be stored in lower case. Defaults to false. Can be |
longStringLength | integer | If the type is LONG_STRING, the max length for this property. Must be a multiple of 100. Defaults to 200. Can be |
The UserActionNamingSettings
object
The settings of user action naming.
Element | Type | Description |
---|---|---|
placeholders | User | User action placeholders. Can be |
loadActionNamingRules | User | User action naming rules for loading actions. Can be |
xhrActionNamingRules | User | User action naming rules for xhr actions. Can be |
customActionNamingRules | User | User action naming rules for custom actions. Can be |
ignoreCase | boolean | Case insensitive naming. Can be |
useFirstDetectedLoadAction | boolean | First load action found under an XHR action should be used when true. Else the deepest one under the xhr action is used Can be |
splitUserActionsByDomain | boolean | Deactivate this setting if different domains should not result in separate user actions. Can be |
queryParameterCleanups | string[] | List of parameters that should be removed from the query before using the query in the user action name. Can be |
The UserActionNamingPlaceholder
object
The placeholder settings.
Element | Type | Description |
---|---|---|
name | string | Placeholder name. |
input | string | Input. |
processingPart | string | Part. |
processingSteps | User | Processing actions. Can be |
metadataId | integer | Id of the metadata. Can be |
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:
|
patternBefore | string | The pattern before the required value. It will be removed. Can be |
patternBeforeSearchType | string | The required occurrence of patternBefore. Can be |
patternAfter | string | The pattern after the required value. It will be removed. Can be |
patternAfterSearchType | string | The required occurrence of patternAfter. Can be |
replacement | string | Replacement for the original value. Can be |
patternToReplace | string | The pattern to be replaced. Only applicable if the type is Can be |
regularExpression | string | A regular expression for the string to be extracted or replaced. Only applicable if the type is Can be |
fallbackToInput | boolean | If set to true: Returns the input if patternBefore or patternAfter cannot be found and the type is Returns the input if regularExpression doesn't match and type is Otherwise null is returned. Can be |
The UserActionNamingRule
object
The settings of naming rule.
Element | Type | Description |
---|---|---|
template | string | Naming pattern. Use Curly brackets |
conditions | User | Defines the conditions when the naming rule should apply. Can be |
useOrConditions | boolean | If set to Can be |
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 Can be |
operator | string | The operator of the condition |
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. |
capturingName | string | The name of the meta data to capture. |
name | string | Name for displaying the captured values in Dynatrace. |
uniqueId | integer | The unique id of the meta data to capture. Can be |
publicMetadata | boolean | True if this metadata should be captured regardless of the privacy settings Can be |
useLastValue | boolean | True if the last captured value should be used for this metadata. By default the first value will be used. Can be |
The ConversionGoal
object
A conversion goal of the application.
Element | Type | Description |
---|---|---|
name | string | The name of the conversion goal. |
id | string | The ID of conversion goal. Omit it while creating a new conversion goal. Can be |
type | string | The type of the conversion goal. Can be |
destinationDetails | Destination | Configuration of a destination-based conversion goal. Can be |
userActionDetails | User | Configuration of a user action-based conversion goal. Can be |
visitDurationDetails | Visit | Configuration of a visit duration-based conversion goal. Can be |
visitNumActionDetails | Visit | Configuration of a number of user actions-based conversion goal. Can be |
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. Can be |
caseSensitive | boolean | The match is case-sensitive ( Can be |
The UserActionDetails
object
Configuration of a user action-based conversion goal.
Element | Type | Description |
---|---|---|
value | string | The value to be matched to hit the conversion goal. Can be |
caseSensitive | boolean | The match is case-sensitive ( Can be |
matchType | string | The operator of the match. Can be |
matchEntity | string | The type of the entity to which the rule applies. Can be |
actionType | string | Type of the action to which the rule applies. Can be |
The VisitDurationDetails
object
Configuration of a visit duration-based conversion goal.
Element | Type | Description |
---|---|---|
durationInMillis | integer | The duration of session to hit the conversion goal, in milliseconds. |
The VisitNumActionDetails
object
Configuration of a number of user actions-based conversion goal.
Element | Type | Description |
---|---|---|
numUserActions | integer | The number of user actions to hit the conversion goal. Can be |
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.
{
"name": "application name",
"type": "AUTO_INJECTED",
"realUserMonitoringEnabled": true,
"sessionReplayConfig": {
"costControlPercentage": 100,
"enabled": true,
"enableCssResourceCapturing": true,
"cssResourceCapturingExclusionRules": [
"rule"
]
},
"costControlUserSessionPercentage": 100,
"loadActionKeyPerformanceMetric": "VISUALLY_COMPLETE",
"xhrActionKeyPerformanceMetric": "ACTION_DURATION",
"loadActionApdexSettings": {
"toleratedThreshold": 3000,
"frustratingThreshold": 12000,
"toleratedFallbackThreshold": 3000,
"frustratingFallbackThreshold": 12000
},
"xhrActionApdexSettings": {
"toleratedThreshold": 2500,
"frustratingThreshold": 10000,
"toleratedFallbackThreshold": 3000,
"frustratingFallbackThreshold": 12000
},
"customActionApdexSettings": {
"toleratedThreshold": 3000,
"frustratingThreshold": 12000,
"toleratedFallbackThreshold": 3000,
"frustratingFallbackThreshold": 12000
},
"waterfallSettings": {
"uncompressedResourcesThreshold": 860,
"resourcesThreshold": 100000,
"resourceBrowserCachingThreshold": 50,
"slowFirstPartyResourcesThreshold": 200000,
"slowThirdPartyResourcesThreshold": 200000,
"slowCdnResourcesThreshold": 200000,
"speedIndexVisuallyCompleteRatioThreshold": 50
},
"monitoringSettings": {
"fetchRequests": false,
"xmlHttpRequest": true,
"javaScriptFrameworkSupport": {
"angular": true,
"dojo": false,
"extJS": false,
"icefaces": false,
"jQuery": true,
"mooTools": false,
"prototype": true,
"activeXObject": false
},
"contentCapture": {
"resourceTimingSettings": {
"w3cResourceTimings": true,
"nonW3cResourceTimings": false,
"nonW3cResourceTimingsInstrumentationDelay": 50
},
"javaScriptErrors": true,
"timeoutSettings": {
"timedActionSupport": false,
"temporaryActionLimit": 0,
"temporaryActionTotalTimeout": 100
},
"visuallyCompleteAndSpeedIndex": true
},
"excludeXhrRegex": "",
"correlationHeaderInclusionRegex": "",
"injectionMode": "JAVASCRIPT_TAG",
"libraryFileLocation": "",
"monitoringDataPath": "",
"customConfigurationProperties": "",
"serverRequestPathId": "",
"secureCookieAttribute": false,
"cookiePlacementDomain": "",
"cacheControlHeaderOptimizations": true,
"advancedJavaScriptTagSettings": {
"syncBeaconFirefox": false,
"syncBeaconInternetExplorer": false,
"instrumentUnsupportedAjaxFrameworks": false,
"specialCharactersToEscape": "",
"maxActionNameLength": 100,
"maxErrorsToCapture": 10,
"additionalEventHandlers": {
"userMouseupEventForClicks": false,
"clickEventHandler": false,
"mouseupEventHandler": false,
"blurEventHandler": false,
"changeEventHandler": false,
"toStringMethod": false,
"maxDomNodesToInstrument": 5000
},
"eventWrapperSettings": {
"click": false,
"mouseUp": false,
"change": false,
"blur": false,
"touchStart": false,
"touchEnd": false
},
"globalEventCaptureSettings": {
"mouseUp": true,
"mouseDown": true,
"click": true,
"doubleClick": true,
"keyUp": true,
"keyDown": true,
"scroll": true,
"additionalEventCapturedAsUserInput": ""
}
},
"browserRestrictionSettings": {
"browserRestrictions": [
{
"browserType": "INTERNET_EXPLORER",
"browserVersion": "0",
"platform": "ALL",
"comparator": "EQUALS"
}
],
"mode": "EXCLUDE"
},
"javaScriptInjectionRules": [
{
"enabled": true,
"urlOperator": "CONTAINS",
"urlPattern": "/lorem/ipsum.jsp",
"rule": "AFTER_SPECIFIC_HTML",
"htmlPattern": "</title>"
}
],
"ipAddressRestrictionSettings": {
"ipAddressRestrictions": [
{
"subnetMask": 3,
"address": "10.0.0.1"
},
{
"address": "10.0.0.1",
"addressTo": "10.0.0.2"
}
],
"mode": "EXCLUDE"
}
},
"userActionNamingSettings": {
"placeholders": [
{
"name": "myPlaceholder",
"input": "PAGE_URL",
"processingPart": "ALL",
"processingSteps": [
{
"type": "SUBSTRING",
"patternBefore": ".*b",
"patternBeforeSearchType": "FIRST",
"patternAfter": ".*a",
"patternAfterSearchType": "LAST",
"replacement": "value"
}
],
"useGuessedElementIdentifier": false
}
],
"loadActionNamingRules": [
{
"template": "Loading of {myPlaceholder}",
"conditions": [
{
"operand1": "{myPlaceholder}",
"operand2": "foo",
"operator": "CONTAINS"
}
]
}
],
"xhrActionNamingRules": [
{
"template": "Loading of {myPlaceholder}",
"conditions": [
{
"operand1": "{myPlaceholder}",
"operand2": "foo",
"operator": "CONTAINS"
}
]
}
],
"ignoreCase": true,
"splitUserActionsByDomain": true
},
"metaDataCaptureSettings": [
{
"type": "JAVA_SCRIPT_VARIABLE",
"capturingName": "variableName",
"name": "display name"
}
],
"conversionGoals": [
{
"name": "conversionGoalName",
"type": "UserAction",
"destinationDetails": {
"urlOrPath": "url or path",
"matchType": "Begins",
"caseSensitive": false
},
"userActionDetails": {
"value": "value to match",
"caseSensitive": true,
"matchType": "Ends",
"matchEntity": "ActionName",
"actionType": "Load"
},
"visitDurationDetails": {
"durationInMillis": 1
},
"visitNumActionDetails": {
"numUserActions": 2
}
}
]
}
Response
Response codes
Code | Type | Description |
---|---|---|
201 | Entity | Success. The response body contains the ID and name of the new web application. |
400 | Error | Failed. The input is invalid. |
Response body objects
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the Dynatrace entity. |
name | string | The name of the Dynatrace entity. Can be |
description | string | A short description of the Dynatrace entity. Can be |
Response body JSON model
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example"
}
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/web/validator |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/web/validator | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applications/web/validator |
Authentication
To execute this request, you need an access token with Write configuration (WriteConfig
) scope. To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Validated. The submitted configuration is valid. Response does not have a body. |
400 | Error | Failed. The input is invalid. |