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

Parameter
Type
Description
In
Required
metricKey
string

The key of the required metric.

path
required

Response

Response codes

Code
Type
Description

Response body objects

The WebApplicationMetric object

Descriptor of the calculated web application metric.

Element
Type
Description
applicationIdentifier
string

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

dimensions

A list of metric dimensions.

enabled
boolean

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

metricDefinition

Definition of the web application metric.

metricKey
string

The unique key of the metric.

The key must have the calc:apps prefix.

name
string

The displayed name of the metric.

The WebApplicationDimensionDefinition object

Dimension of the calculated web application metrics.

Element
Type
Description
dimension
string

The dimension of the metric.

  • ApdexType
  • Browser
  • ErrorContext
  • ErrorOrigin
  • ErrorType
  • GeoLocation
  • StringProperty
  • UserActionType
propertyKey
string

The key of the user action property.

Only applicable for the StringProperty dimension.

topX
integer

The number of top values to be calculated.

The WebApplicationMetricDefinition object

Definition of the web application metric.

Element
Type
Description
metric
string

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
propertyKey
string

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.

Element
Type
Description
actionDurationFromMilliseconds
integer

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

actionDurationToMilliseconds
integer

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

apdex
string

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

  • Frustrated
  • Satisfied
  • Tolerating
  • Unknown
browserFamily
string

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

The EQUALS operator applies.

browserType
string

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

The EQUALS operator applies.

browserVersion
string

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

The EQUALS operator applies.

The UserActionPropertyFilter object

User action property filter.

Element
Type
Description
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.

key
string

The key of the action property we're checking.

matchType
string

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

Only applicable to string values.

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

value
string

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