Web application metrics API - GET a metric

Gets the descriptor of the specified calculated web application metric.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/rum/{metricKey}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/calculatedMetrics/rum/{metricKey}

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

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.

dimensionsWebApplicationDimensionDefinition[]

A list of metric dimensions.

enabledboolean

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

metricDefinitionWebApplicationMetricDefinition

Definition of the web application metric.

metricKeystring

The unique key of the metric.

The key must have the calc:apps prefix.

namestring

The displayed name of the metric.

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.

The WebApplicationDimensionDefinition object

Dimension of the calculated web application metrics.

ElementTypeDescription
dimensionstring

The dimension of the metric.

  • ApdexType
  • Browser
  • ErrorContext
  • ErrorOrigin
  • ErrorType
  • GeoLocation
  • StringProperty
  • UserActionType
propertyKeystring

The key of the user action property.

Only applicable for the StringProperty dimension.

topXinteger

The number of top values to be calculated.

The WebApplicationMetricDefinition object

Definition of the web application metric.

ElementTypeDescription
metricstring

The type of the web application metric.

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

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.

actionDurationToMillisecondsinteger

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

apdexstring

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

  • Frustrated
  • Satisfied
  • Tolerating
  • Unknown
browserFamilystring

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

The EQUALS operator applies.

browserTypestring

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

The EQUALS operator applies.

browserVersionstring

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

The EQUALS operator applies.

citystring

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

Specify geolocation ID here.

continentstring

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

Specify geolocation ID here.

countrystring

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

Specify geolocation ID here.

customActionboolean

The status of custom actions in the metric calculation:

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

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

customErrorTypestring

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

domainstring

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

The EQUALS operator applies.

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

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

httpErrorCodeTointeger

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

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.

ipstring

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

The EQUALS operator applies.

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

The status of load actions in the metric calculation:

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

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

Specify the OS ID here.

osVersionstring

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

Specify the OS ID here.

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

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

Specify geolocation ID here.

robotboolean

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

  • true: Only actions from robots are included.
  • false: All actions are included.
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.
targetViewGroupstring

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

targetViewGroupNameMatchTypestring

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

  • Contains
  • Equals
targetViewNamestring

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

targetViewNameMatchTypestring

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

  • Contains
  • Equals
userActionNamestring

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

The EQUALS operator applies.

userActionPropertiesUserActionPropertyFilter[]

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

xhrActionboolean

The status of XHR actions in the metric calculation:

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

The status of route change actions in the metric calculation:

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

The UserActionPropertyFilter object

User action property filter.

ElementTypeDescription
fromnumber

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

Only applicable to numerical values.

keystring

The key of the action property we're checking.

matchTypestring

Specifies the match type of a string filter, e.g. using Contains or Equals.

Only applicable to string values.

  • Contains
  • Equals
tonumber

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

Only applicable to numerical values.

valuestring

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

Only applicable to string values.

Response body JSON model

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

Related topics