Web application metrics API - POST a metric

Creates a new calculated web application metric.

The request consumes and produces an application/json payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/rum SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/rum

Authentication

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

Parameters

Parameter	Type	Description	In	Required
body	WebApplicationMetric	The JSON body of the request. Contains the descriptor of the new calculated web application metric.	body	optional

Body format

Request parameters JSON model

The WebApplicationMetric object

Descriptor of the calculated web application metric.

Element	Type	Description	Required
applicationIdentifier	string	The Dynatrace entity ID of the application to which the metric belongs.	required
name	string	The displayed name of the metric.	required
metricKey	string	The unique key of the metric. The key must have the `calc:apps` prefix.	required
enabled	boolean	The metric is enabled (`true`) or disabled (`false`).	required
metricDefinition	WebApplicationMetricDefinition		required
dimensions	WebApplicationDimensionDefinition[]	A list of metric dimensions.	optional
userActionFilter	UserActionFilter		optional

The UserActionFilter object

User actions filter of the calculated web application metric.

Only user actions matching the provided criteria are used for metric calculation.

A user action must match all the criteria.

Element	Type	Description	Required
actionDurationFromMilliseconds	integer	Only actions with a duration more than or equal to this value (in milliseconds) are included in the metric calculation.	optional
actionDurationToMilliseconds	integer	Only actions with a duration less than or equal to this value (in milliseconds) are included in the metric calculation.	optional
loadAction	boolean	The status of load actions in the metric calculation: `true`: Load actions are included. `false`: All actions are included.	optional
xhrAction	boolean	The status of XHR actions in the metric calculation: `true`: XHR actions are included. `false`: All actions are included.	optional
xhrRouteChangeAction	boolean	The status of route change actions in the metric calculation: `true`: Route change actions are included. `false`: All actions are included.	optional
customAction	boolean	The status of custom actions in the metric calculation: `true`: Custom actions are included. `false`: All actions are included.	optional
apdex	string	Only actions with the specified Apdex score are included in the metric calculation. The element can hold these values Frustrated Satisfied Tolerating Unknown	optional
domain	string	Only user actions coming from the specified domain are included in the metric calculation. The EQUALS operator applies.	optional
userActionName	string	Only actions with this name are included in the metric calculation. The EQUALS operator applies.	optional
realUser	boolean	The status of actions coming from real users in the metric calculation: `true`: Only actions from real users are included. `false`: All actions are included.	optional
robot	boolean	The status of actions coming from robots in the metric calculation: `true`: Only actions from robots are included. `false`: All actions are included.	optional
synthetic	boolean	The status of actions coming from synthetic monitors in the metric calculation: `true`: Only actions from synthetic monitors are included. `false`: All actions are included.	optional
browserFamily	string	Only user actions coming from the specified browser family are included in the metric calculation. The EQUALS operator applies.	optional
browserType	string	Only user actions coming from the specified browser type are included in the metric calculation. The EQUALS operator applies.	optional
browserVersion	string	Only user actions coming from the specified browser version are included in the metric calculation. The EQUALS operator applies.	optional
hasCustomErrors	boolean	The custom error status of the actions to be included in the metric calculation: `true`: Only actions with custom errors are included. `false`: All actions are included.	optional
hasAnyError	boolean	The error status of the actions to be included in the metric calculation: `true`: Only actions that have any errors are included. `false`: All actions are included.	optional
hasHttpErrors	boolean	The HTTP error status of the actions to be included in the metric calculation: `true`: Only actions with HTTP errors are included. `false`: All actions are included.	optional
hasJavascriptErrors	boolean	The JavaScript error status of the actions to be included in the metric calculation: `true`: Only actions with JavaScript errors are included. `false`: All actions are included.	optional
city	string	Only actions of users from this city are included in the metric calculation. Specify geolocation ID here.	optional
continent	string	Only actions of users from this continent are included in the metric calculation. Specify geolocation ID here.	optional
country	string	Only actions of users from this country are included in the metric calculation. Specify geolocation ID here.	optional
region	string	Only actions of users from this region are included in the metric calculation. Specify geolocation ID here.	optional
ip	string	Only actions coming from this IP address are included in the metric calculation. The EQUALS operator applies.	optional
ipV6Traffic	boolean	The IPv6 status of the actions to be included in the metric calculation: `true`: Only actions coming from IPv6 are included. `false`: All actions are included.	optional
osFamily	string	Only actions coming from this OS family are included in the metric calculation. Specify the OS ID here.	optional
osVersion	string	Only actions coming from this OS version are included in the metric calculation. Specify the OS ID here.	optional
httpErrorCode	integer	The HTTP error status code of the actions to be included in the metric calculation.	optional
httpPath	string	The request path that has been determined to be the origin of an HTTP error of the actions to be included in the metric calculation.	optional
customErrorType	string	The custom error type of the actions to be included in the metric calculation.	optional
customErrorName	string	The custom error name of the actions to be included in the metric calculation.	optional
userActionProperties	UserActionPropertyFilter[]	Only actions with the specified properties are included in the metric calculation.	optional
targetViewName	string	Only actions on the specified view are included in the metric calculation. The EQUALS operator applies.	optional
targetViewGroup	string	Only actions on the specified group of views are included in the metric calculation. The EQUALS operator applies.	optional

The UserActionPropertyFilter object

User action property filter.

Element	Type	Description	Required
key	string	The key of the action property we're checking.	optional
value	string	Only actions that have this value in the specified property are included in the metric calculation. Only applicable to string values.	optional
from	number	Only actions that have a value greater than or equal to this are included in the metric calculation. Only applicable to numerical values.	optional
to	number	Only actions that have a value less than or equal to this are included in the metric calculation. Only applicable to numerical values.	optional
matchType	string	Specifies the match type of a string filter, e.g. using `Contains` or `Equals`. Only applicable to string values. The element can hold these values Contains Equals	optional

The WebApplicationDimensionDefinition object

Dimension of the calculated web application metrics.

Element Type Description Required

topX

integer

Element	Type	Description	Required
topX	integer	The number of top values to be calculated.	required
dimension	string	The dimension of the metric. The element can hold these values ApdexType Browser ErrorContext ErrorOrigin ErrorType GeoLocation StringProperty UserActionType	required
propertyKey	string	The key of the user action property. Only applicable for the `StringProperty` dimension.	optional

The number of top values to be calculated.

required

dimension

string

The dimension of the metric.

The element can hold these values

ApdexType
Browser
ErrorContext
ErrorOrigin
ErrorType
GeoLocation
StringProperty
UserActionType

required

propertyKey

string

The key of the user action property.

Only applicable for the StringProperty dimension.

optional

The WebApplicationMetricDefinition object

Definition of the web application metric.

Element Type Description Required

metric

string

Element	Type	Description	Required
metric	string	The type of the web application metric. The element can hold these values Apdex ApplicationCache Callback CumulativeLayoutShift DNSLookup DOMComplete DOMContentLoaded DOMInteractive DoubleProperty ErrorCount FirstContentfulPaint FirstInputDelay FirstInputStart FirstPaint HTMLDownloaded LargestContentfulPaint LoadEventEnd LoadEventStart LongProperty LongTasksTime NavigationStart OnDOMContentLoaded OnLoad Processing RedirectTime Request RequestStart Response SecureConnect SpeedIndex TCPConnect TimeToFirstByte UserActionDuration VisuallyComplete	required
propertyKey	string	The key of the user action property. Only applicable for `DoubleProperty` and `LongProperty` metrics.	optional

The type of the web application metric.

The element can hold these values

Apdex
ApplicationCache
Callback
CumulativeLayoutShift
DNSLookup
DOMComplete
DOMContentLoaded
DOMInteractive
DoubleProperty
ErrorCount
FirstContentfulPaint
FirstInputDelay
FirstInputStart
FirstPaint
HTMLDownloaded
LargestContentfulPaint
LoadEventEnd
LoadEventStart
LongProperty
LongTasksTime
NavigationStart
OnDOMContentLoaded
OnLoad
Processing
RedirectTime
Request
RequestStart
Response
SecureConnect
SpeedIndex
TCPConnect
TimeToFirstByte
UserActionDuration
VisuallyComplete

required

propertyKey

string

The key of the user action property.

Only applicable for DoubleProperty and LongProperty metrics.

optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "enabled": true,
  "name": "MyMetric",
  "metricKey": "calc:apps.web.mymetric",
  "metricDefinition": {
    "metric": "UserActionDuration"
  },
  "applicationIdentifier": "APPLICATION-1234",
  "userActionFilter": {
    "loadAction": true,
    "country": "GEOLOCATION-1234",
    "browserType": "BROWSER-1234"
  },
  "dimensions": [
    {
      "dimension": "GeoLocation",
      "topX": 20
    }
  ]
}

Response

Response codes

Code	Description
201	Success. The metric has been created. Response contains its key and name.
400	Failed. The input is invalid.

Response body

Response parameters JSON model

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.
description	string	A short description of the Dynatrace entity.

    
{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example\n"
}

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/calculatedMetrics/rum/validator SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/rum/validator

Authentication

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

Response

Response codes

Code	Description
204	Validated. The submitted metric is valid. The response doesn't have a body.
400	Failed. The input is invalid.

Response body

A successful request doesn't return any content.