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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/rum/{metricKey} |
Environment ActiveGate | https://{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 |
---|---|---|
200 | Web | Success |
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 | Web | A list of metric dimensions. |
enabled | boolean | The metric is enabled ( |
metricDefinition | Web | Definition of the web application metric. |
metricKey | string | The unique key of the metric. The key must have the |
name | string | The displayed name of the metric. |
userActionFilter | User | 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.
Element | Type | Description |
---|---|---|
dimension | string | The dimension of the metric.
|
propertyKey | string | The key of the user action property. Only applicable for the |
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.
|
propertyKey | string | The key of the user action property. Only applicable for |
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.
|
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. |
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. |
customAction | boolean | The status of custom actions in the metric calculation:
|
customErrorName | string | The custom error name 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. |
domain | string | Only user actions coming from the specified domain are included in the metric calculation. The EQUALS operator applies. |
hasAnyError | boolean | The error status of the actions to be included in the metric calculation:
|
hasCustomErrors | boolean | The custom error status of the actions to be included in the metric calculation:
|
hasHttpErrors | boolean | The request error status of the actions to be included in the metric calculation:
|
hasJavascriptErrors | boolean | The JavaScript error status of the actions to be included in the metric calculation:
|
httpErrorCode | integer | The HTTP error status code of the actions to be included in the metric calculation. |
httpErrorCodeTo | integer | Can be used in combination with |
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. |
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:
|
loadAction | boolean | The status of load actions in the metric calculation:
|
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. |
realUser | boolean | The status of actions coming from real users in the metric calculation:
|
region | string | Only actions of users from this region are included in the metric calculation. Specify geolocation ID here. |
robot | boolean | The status of actions coming from robots in the metric calculation:
|
synthetic | boolean | The status of actions coming from synthetic monitors in the metric calculation:
|
targetViewGroup | string | Only actions on the specified group of views are included in the metric calculation. |
targetViewGroupNameMatchType | string | Specifies the match type of the view group filter, e.g. using
|
targetViewName | string | Only actions on the specified view are included in the metric calculation. |
targetViewNameMatchType | string | Specifies the match type of the view name filter, e.g. using
|
userActionName | string | Only actions with this name are included in the metric calculation. The EQUALS operator applies. |
userActionProperties | User | Only actions with the specified properties are included in the metric calculation. |
xhrAction | boolean | The status of XHR actions in the metric calculation:
|
xhrRouteChangeAction | boolean | The status of route change actions in the metric calculation:
|
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 Only applicable to string 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. |
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}}