Mobile app metrics API - GET a metric

Gets the descriptor of the specified calculated mobile app metric.

The request produces an application/json payload.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile/{metricKey}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/mobile/{metricKey}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile/{metricKey}`

Authentication

To execute this request, you need 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	Type	Description
200	CalculatedMobileMetric	Success

Response body objects

The `CalculatedMobileMetric` object

Definition of the calculated metric for mobile or custom app.

Element	Type	Description	Required
applicationIdentifier	string	The Dynatrace entity ID of the application to which the metric belongs.	required
name	string	The name of the metric, displayed in the UI.	required
metricKey	string	The unique key of the metric. The key must have the `calc:apps` prefix.	required
enabled	boolean	The metric is enabled (`true`) or disabled (`false`).	required
metricType	string	The type of the metric. The element can hold these values `REPORTED_ERROR_COUNT` `USER_ACTION_DURATION` `WEB_REQUEST_COUNT` `WEB_REQUEST_ERROR_COUNT`	required
dimensions	CalculatedMobileMetricDimension[]	A list of metric dimensions.	optional
userActionFilter	CalculatedMobileMetricUserActionFilter	User actions filter of the calculated metric for mobile or custom app.	optional

The `CalculatedMobileMetricDimension` object

Dimension of the calculated mobile metric.

Element	Type	Description	Required
topX	integer	The number of top values to be calculated.	required
dimension	string	The dimension of the metric. The element can hold these values `APP_VERSION` `DEVICE` `ERROR_CONTEXT` `GEOLOCATION` `MANUFACTURER` `OS`	required

The `CalculatedMobileMetricUserActionFilter` object

User actions filter of the calculated metric for mobile or custom app.

Element	Type	Description	Required
hasReportedError	boolean	The error status of the actions to be included in the metric calculation: `true`: Only actions with reported errors are included. `false`: All actions are included.	optional
hasHttpError	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.	optional
userActionName	string	Only actions with this name are included in the metric calculation. The EQUALS operator applies.	optional
appVersion	string	Only actions coming from this app version are included in the metric calculation. The EQUALS operator applies.	optional
device	string	Only actions coming from this app version are included in the metric calculation. The EQUALS operator applies.	optional
manufacturer	string	Only actions coming from devices of this manufacturer are included in the metric calculation. The EQUALS operator applies.	optional
apdex	string	Only actions with the specified Apdex score are included in the metric calculation. The element can hold these values `Frustrated` `Satisfied` `Tolerating` `Unknown`	optional
osFamily	string	Only actions coming from this OS family are included in the metric calculation. Specify the OS ID here.	optional
osVersion	string	Only actions coming from this OS version are included in the metric calculation. Specify the OS ID here.	optional
city	string	Only actions of users from this city are included in the metric calculation. Specify geolocation ID here.	optional
continent	string	Only actions of users from this continent are included in the metric calculation. Specify geolocation ID here.	optional
country	string	Only actions of users from this country are included in the metric calculation. Specify geolocation ID here.	optional
region	string	Only actions of users from this region are included in the metric calculation. Specify geolocation ID here.	optional
actionDurationFromMilliseconds	integer	Only actions with a duration more than or equal to this value (in milliseconds) are included in the metric calculation.	optional
actionDurationToMilliseconds	integer	Only actions with a duration less than or equal to this value (in milliseconds) are included in the metric calculation.	optional
carrier	string	Only actions coming from this carrier type are included in the metric calculation.	optional
connectionType	string	Only actions coming from this connection type are included in the metric calculation. The element can hold these values `LAN` `MOBILE` `OFFLINE` `UNKNOWN` `WIFI`	optional
networkTechnology	string	Filter by network technology	optional
isp	string	Only actions coming from this internet service provider are included in the metric calculation. The EQUALS operator applies.	optional
orientation	string	Only actions coming from devices with this display orientation are included in the metric calculation. The element can hold these values `LANDSCAPE` `PORTRAIT` `UNKNOWN`	optional
resolution	string	Only actions coming from devices with this display resolution are included in the metric calculation. The element can hold these values `CGA` `DCI2K` `DCI4K` `DVGA` `FHD` `FWVGA` `FWXGA` `GHDPlus` `HD` `HQVGA` `HQVGA2` `HSXGA` `HUXGA` `HVGA` `HXGA` `NTSC` `PAL` `QHD` `QQVGA` `QSXGA` `QUXGA` `QVGA` `QWXGA` `QXGA` `SVGA` `SXGA` `SXGAMinus` `SXGAPlus` `UGA` `UHD16K` `UHD4K` `UHD8K` `UHDPlus` `UNKNOWN` `UWQHD` `UXGA` `VGA` `WHSXGA` `WHUXGA` `WHXGA` `WQSXGA` `WQUXGA` `WQVGA` `WQVGA2` `WQVGA3` `WQXGA` `WQXGA2` `WSVGA` `WSVGA2` `WSXGA` `WSXGAPlus` `WUXGA` `WVGA` `WVGA2` `WXGA` `WXGA2` `WXGA3` `WXGAPlus` `XGA` `XGAPLUS` `_1280x854` `nHD` `qHD`	optional

Response body JSON model

json
{
  "enabled": true,
  "name": "MyMetric",
  "metricKey": "calc:apps.mobile.mymetric",
  "applicationIdentifier": "MOBILE_APPLICATION-1234",
  "metricType": "USER_ACTION_DURATION",
  "userActionFilter": {
    "hasHttpError": true,
    "country": "GEOLOCATION-1234",
    "osVersion": "OS-1234"
  },
  "dimensions": [
    {
      "dimension": "GEOLOCATION",
      "topX": 20
    }
  ]
}