RUM metrics API - GET a metric

Gets the definition of the specified calculated RUM metric.

The request produces an application/json payload.

Early Adopter

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

GET
  • Managed 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}

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter Type Description In Required
metricKey string

The ID of the calculated RUM metric you're inquiring.

path required

Response format

The RumMetric object

Element Type Description
applicationIdentifier string

The application identifier of the application where this RumMetric should belong to

name string

The name of the RumMetric config

metricKey string

The unique key of this RumMetric. Has to start with "calc:apps."

enabled boolean

RumMetric enabled/disabled

metricDefinition RumMetricDefinition
dimensions RumDimensionDefinition[]

Specifies the optional dimensions for this RumMetric.

userActionFilter UserActionFilter

The UserActionFilter object

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

Element Type Description
actionDurationFromMilliseconds integer

Filter by user actions with an action duration >= this value

actionDurationToMilliseconds integer

Filter by user actions with an action duration <= this value

loadAction boolean

Filter by LoadActions

xhrAction boolean

Filter by XhrActions

customAction boolean

Filter by CustomActions

apdex string

Filter by Apdex

The apdex element can hold these values.
domain string

Filter by domain

userActionName string

Filter by userAction name

realUser boolean

Filter by realUsers

robot boolean

Filter by robots

synthetic boolean

Filter by synthetic

browserFamily string

Filter by browser family

browserType string

Filter by browser family

browserVersion string

Filter by browser version

hasCustomErrors boolean

Filter by custom errors

hasAnyError boolean

Filter by any error

hasHttpErrors boolean

Filter by http errors

hasJavascriptErrors boolean

Filter by javascript errors

city string

Filter by city

continent string

Filter by continent

country string

Filter by country

region string

Filter by region

ip string

Filter by ip

ipV6Traffic boolean

Filter by ipV6Traffic

osFamily string

Filter by osFamily

osVersion string

Filter by osVersion

userActionProperties UserActionPropertyFilter[]

Filter by user action properties

The UserActionPropertyFilter object

Element Type Description
key string

The key of the user action property

value string

Filter by a string value (only for properties of type string)

from number

Filter by values >= this value (only for properties of numeric type)

to number

Filter by values <= this value (only for properties of numeric type)

The RumDimensionDefinition object

Element Type Description
topX integer

The number of top values to be calculated.

dimension string

The dimension of this metric.

The dimension element can hold these values.
propertyKey string

The key of the user action property. Only required if dimension is set to "StringProperty"

The RumMetricDefinition object

Specifies the metric definition for this RumMetric.

Element Type Description
metric string

The type of metric this RumMetricDefinition holds

The metric element can hold these values.
propertyKey string

The key of the user action property. Only required if metric is set to "DoubleProperty" or "LongProperty"

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