RUM metrics API - POST a metric

Creates a new calculated RUM metric.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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

Parameters

Parameter	Type	Description	In	Required
body	RumMetric	JSON body of the request containing definition of the new calculated RUM metric.	body	optional

Request parameters JSON model

The RumMetric object

Element	Type	Description	Required
applicationIdentifier	string	The application identifier of the application where this RumMetric should belong to	required
name	string	The name of the RumMetric config	required
metricKey	string	The unique key of this RumMetric. Has to start with "calc:apps."	required
enabled	boolean	RumMetric enabled/disabled	required
metricDefinition	RumMetricDefinition		required
dimensions	RumDimensionDefinition[]	Specifies the optional dimensions for this RumMetric.	optional
userActionFilter	UserActionFilter		optional

The UserActionFilter object

An optional filter. Only user actions matching this filter are used for metric calculation.

Element	Type	Description	Required
actionDurationFromMilliseconds	integer	Filter by user actions with an action duration >= this value	optional
actionDurationToMilliseconds	integer	Filter by user actions with an action duration <= this value	optional
loadAction	boolean	Filter by LoadActions	optional
xhrAction	boolean	Filter by XhrActions	optional
customAction	boolean	Filter by CustomActions	optional
apdex	string	Filter by Apdex The apdex element can hold these values.	optional
domain	string	Filter by domain	optional
userActionName	string	Filter by userAction name	optional
realUser	boolean	Filter by realUsers	optional
robot	boolean	Filter by robots	optional
synthetic	boolean	Filter by synthetic	optional
browserFamily	string	Filter by browser family	optional
browserType	string	Filter by browser family	optional
browserVersion	string	Filter by browser version	optional
hasCustomErrors	boolean	Filter by custom errors	optional
hasAnyError	boolean	Filter by any error	optional
hasHttpErrors	boolean	Filter by http errors	optional
hasJavascriptErrors	boolean	Filter by javascript errors	optional
city	string	Filter by city	optional
continent	string	Filter by continent	optional
country	string	Filter by country	optional
region	string	Filter by region	optional
ip	string	Filter by ip	optional
ipV6Traffic	boolean	Filter by ipV6Traffic	optional
osFamily	string	Filter by osFamily	optional
osVersion	string	Filter by osVersion	optional
userActionProperties	UserActionPropertyFilter[]	Filter by user action properties	optional

The UserActionPropertyFilter object

Element	Type	Description	Required
key	string	The key of the user action property	optional
value	string	Filter by a string value (only for properties of type string)	optional
from	number	Filter by values >= this value (only for properties of numeric type)	optional
to	number	Filter by values <= this value (only for properties of numeric type)	optional

The RumDimensionDefinition object

Element	Type	Description	Required
topX	integer	The number of top values to be calculated.	required
dimension	string	The dimension of this metric. The dimension element can hold these values.	required
propertyKey	string	The key of the user action property. Only required if dimension is set to "StringProperty"	optional

The RumMetricDefinition object

Specifies the metric definition for this RumMetric.

Element	Type	Description	Required
metric	string	The type of metric this RumMetricDefinition holds The metric element can hold these values.	required
propertyKey	string	The key of the user action property. Only required if metric is set to "DoubleProperty" or "LongProperty"	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
    }
  ]
}

Possible values

Possible values for the apdex element in the UserActionFilter object:

Frustrated
Satisfied
Tolerating
Unknown

Possible values for the dimension element in the RumDimensionDefinition object:

Browser
ErrorContext
ErrorOrigin
ErrorType
GeoLocation
StringProperty
UserActionType

Possible values for the metric element in the RumMetricDefinition object:

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

Response format

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.

{}

Response codes

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

Validate payload

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

The request consumes an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

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

Response codes

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