Web application metrics API - GET a metric

Gets the descriptor of the specified calculated web application metric.

The request produces an application/json payload.

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 Tokens and authentication.

Parameters

Parameter Type Description In Required
metricKey string

The key of the required metric.

path required

Response

Response codes

Code Description
200

Success

Response body

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.

name string

The displayed name of the metric.

metricKey string

The unique key of the metric.

The key must have the calc:apps prefix.

enabled boolean

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

metricDefinition WebApplicationMetricDefinition
dimensions WebApplicationDimensionDefinition[]

A list of metric dimensions.

userActionFilter UserActionFilter

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.

loadAction boolean

The status of load actions in the metric calculation:

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

The status of XHR actions in the metric calculation:

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

The status of route change actions in the metric calculation:

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

The status of custom actions in the metric calculation:

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

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

domain string

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

The EQUALS operator applies.

userActionName string

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

The EQUALS operator applies.

realUser boolean

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.
robot boolean

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

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

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

hasCustomErrors boolean

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.
hasAnyError boolean

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.
hasHttpErrors boolean

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

  • true: Only actions with HTTP errors are included.
  • false: All actions are included.
hasJavascriptErrors boolean

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.
city string

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

Specify geolocation ID here.

continent string

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

Specify geolocation ID here.

country string

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

Specify geolocation ID here.

region string

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

Specify geolocation ID here.

ip string

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

The EQUALS operator applies.

ipV6Traffic boolean

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.
osFamily string

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

Specify the OS ID here.

osVersion string

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

Specify the OS ID here.

httpErrorCode integer

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

httpPath string

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.

customErrorType string

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

customErrorName string

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

userActionProperties UserActionPropertyFilter[]

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

targetViewName string

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

The EQUALS operator applies.

targetViewGroup string

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

The EQUALS operator applies.

The UserActionPropertyFilter object

User action property filter.

Element Type Description
key string

The key of the action property we're checking.

value string

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

Only applicable to string values.

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.

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.

matchType string

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

Only applicable to string values.

The WebApplicationDimensionDefinition object

Dimension of the calculated web application metrics.

Element Type Description
topX integer

The number of top values to be calculated.

dimension string

The dimension of the metric.

propertyKey string

The key of the user action property.

Only applicable for the StringProperty dimension.

The WebApplicationMetricDefinition object

Definition of the web application metric.

Element Type Description
metric string

The type of the web application metric.

propertyKey string

The key of the user action property.

Only applicable for DoubleProperty and LongProperty metrics.