• Home
  • Dynatrace API
  • Configuration
  • Calculated metrics
  • Web applications
  • GET a metric

Web application metrics API - GET a metric

Gets the descriptor of the specified calculated web application metric.

The request produces an application/json payload.

GETManaged https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/rum/{metricKey}
SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/rum/{metricKey}
Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/rum/{metricKey}

Authentication

To execute this request, you need an access token with Read configuration (ReadConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
metricKeystring

The key of the required metric.

pathrequired

Response

Response codes

CodeTypeDescription
200WebApplicationMetric

Success

Response body objects

The WebApplicationMetric object

Descriptor of the calculated web application metric.

ElementTypeDescription
applicationIdentifierstring

The Dynatrace entity ID of the application to which the metric belongs.

namestring

The displayed name of the metric.

metricKeystring

The unique key of the metric.

The key must have the calc:apps prefix.

enabledboolean

The metric is enabled (true) or disabled (false).

metricDefinitionWebApplicationMetricDefinition

Definition of the web application metric.

dimensionsWebApplicationDimensionDefinition[]

A list of metric dimensions.

Can be null.

userActionFilterUserActionFilter

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.

Can be null.

The WebApplicationMetricDefinition object

Definition of the web application metric.

ElementTypeDescription
metricstring

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
propertyKeystring

The key of the user action property.

Only applicable for DoubleProperty and LongProperty metrics.

Can be null.

The WebApplicationDimensionDefinition object

Dimension of the calculated web application metrics.

ElementTypeDescription
topXinteger

The number of top values to be calculated.

dimensionstring

The dimension of the metric.

The element can hold these values
  • ApdexType
  • Browser
  • ErrorContext
  • ErrorOrigin
  • ErrorType
  • GeoLocation
  • StringProperty
  • UserActionType
propertyKeystring

The key of the user action property.

Only applicable for the StringProperty dimension.

Can be null.

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.

ElementTypeDescription
actionDurationFromMillisecondsinteger

Only actions with a duration more than or equal to this value (in milliseconds) are included in the metric calculation.

Can be null.

actionDurationToMillisecondsinteger

Only actions with a duration less than or equal to this value (in milliseconds) are included in the metric calculation.

Can be null.

loadActionboolean

The status of load actions in the metric calculation:

  • true: Load actions are included.
  • false: All actions are included.

Can be null.

xhrActionboolean

The status of XHR actions in the metric calculation:

  • true: XHR actions are included.
  • false: All actions are included.

Can be null.

xhrRouteChangeActionboolean

The status of route change actions in the metric calculation:

  • true: Route change actions are included.
  • false: All actions are included.

Can be null.

customActionboolean

The status of custom actions in the metric calculation:

  • true: Custom actions are included.
  • false: All actions are included.

Can be null.

apdexstring

Only actions with the specified Apdex score are included in the metric calculation.

The element can hold these values
  • Frustrated
  • Satisfied
  • Tolerating
  • Unknown

Can be null.

domainstring

Only user actions coming from the specified domain are included in the metric calculation.

The EQUALS operator applies.

Can be null.

userActionNamestring

Only actions with this name are included in the metric calculation.

The EQUALS operator applies.

Can be null.

realUserboolean

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.

Can be null.

robotboolean

The status of actions coming from robots in the metric calculation:

  • true: Only actions from robots are included.
  • false: All actions are included.

Can be null.

syntheticboolean

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.

Can be null.

browserFamilystring

Only user actions coming from the specified browser family are included in the metric calculation.

The EQUALS operator applies.

Can be null.

browserTypestring

Only user actions coming from the specified browser type are included in the metric calculation.

The EQUALS operator applies.

Can be null.

browserVersionstring

Only user actions coming from the specified browser version are included in the metric calculation.

The EQUALS operator applies.

Can be null.

hasCustomErrorsboolean

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.

Can be null.

hasAnyErrorboolean

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.

Can be null.

hasHttpErrorsboolean

The request error status of the actions to be included in the metric calculation:

  • true: Only actions with request errors (HTTP errors, failed images, CSP rule violations) are included.
  • false: All actions are included.

Can be null.

hasJavascriptErrorsboolean

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.

Can be null.

citystring

Only actions of users from this city are included in the metric calculation.

Specify geolocation ID here.

Can be null.

continentstring

Only actions of users from this continent are included in the metric calculation.

Specify geolocation ID here.

Can be null.

countrystring

Only actions of users from this country are included in the metric calculation.

Specify geolocation ID here.

Can be null.

regionstring

Only actions of users from this region are included in the metric calculation.

Specify geolocation ID here.

Can be null.

ipstring

Only actions coming from this IP address are included in the metric calculation.

The EQUALS operator applies.

Can be null.

ipV6Trafficboolean

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.

Can be null.

osFamilystring

Only actions coming from this OS family are included in the metric calculation.

Specify the OS ID here.

Can be null.

osVersionstring

Only actions coming from this OS version are included in the metric calculation.

Specify the OS ID here.

Can be null.

httpErrorCodeinteger

The HTTP error status code of the actions to be included in the metric calculation.

Can be null.

httpErrorCodeTointeger

Can be used in combination with httpErrorCode to define a range of error codes that will be included in the metric calculation.

Can be null.

httpPathstring

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.

Can be null.

customErrorTypestring

The custom error type of the actions to be included in the metric calculation.

Can be null.

customErrorNamestring

The custom error name of the actions to be included in the metric calculation.

Can be null.

userActionPropertiesUserActionPropertyFilter[]

Only actions with the specified properties are included in the metric calculation.

Can be null.

targetViewNamestring

Only actions on the specified view are included in the metric calculation.

Can be null.

targetViewNameMatchTypestring

Specifies the match type of the view name filter, e.g. using Contains or Equals. Defaults to Equals.

The element can hold these values
  • Contains
  • Equals

Can be null.

targetViewGroupstring

Only actions on the specified group of views are included in the metric calculation.

Can be null.

targetViewGroupNameMatchTypestring

Specifies the match type of the view group filter, e.g. using Contains or Equals. Defaults to Equals.

The element can hold these values
  • Contains
  • Equals

Can be null.

The UserActionPropertyFilter object

User action property filter.

ElementTypeDescription
keystring

The key of the action property we're checking.

Can be null.

valuestring

Only actions that have this value in the specified property are included in the metric calculation.

Only applicable to string values.

Can be null.

fromnumber

Only actions that have a value greater than or equal to this are included in the metric calculation.

Only applicable to numerical values.

Can be null.

tonumber

Only actions that have a value less than or equal to this are included in the metric calculation.

Only applicable to numerical values.

Can be null.

matchTypestring

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

Can be null.

Response body JSON model

json
{ "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 } ] }
Related topics
  • Create calculated metrics

    Learn more about calculated metrics.