• Home
  • Dynatrace API
  • Configuration
  • Calculated metrics
  • Mobile app
  • GET a metric

Mobile app metrics API - GET a metric

Gets the descriptor of the specified calculated mobile app metric.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile/{metricKey}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/mobile/{metricKey}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile/{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

ParameterTypeDescriptionInRequired
metricKeystring

The key of the required metric.

pathrequired

Response

Response codes

CodeTypeDescription
200CalculatedMobileMetric

Success

Response body objects

The CalculatedMobileMetric object

Definition of the calculated metric for mobile or custom app.

ElementTypeDescription
applicationIdentifierstring

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

namestring

The name of the metric, displayed in the UI.

metricKeystring

The unique key of the metric.

The key must have the calc:apps prefix.

enabledboolean

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

metricTypestring

The type of the metric.

The element can hold these values
  • REPORTED_ERROR_COUNT
  • USER_ACTION_DURATION
  • WEB_REQUEST_COUNT
  • WEB_REQUEST_ERROR_COUNT
dimensionsCalculatedMobileMetricDimension[]

A list of metric dimensions.

userActionFilterCalculatedMobileMetricUserActionFilter

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

The CalculatedMobileMetricDimension object

Dimension of the calculated mobile metric.

ElementTypeDescription
topXinteger

The number of top values to be calculated.

dimensionstring

The dimension of the metric.

The element can hold these values
  • APP_VERSION
  • DEVICE
  • ERROR_CONTEXT
  • GEOLOCATION
  • MANUFACTURER
  • OS

The CalculatedMobileMetricUserActionFilter object

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

ElementTypeDescription
hasReportedErrorboolean

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.

hasHttpErrorboolean

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.

userActionNamestring

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

The EQUALS operator applies.

appVersionstring

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

The EQUALS operator applies.

devicestring

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

The EQUALS operator applies.

manufacturerstring

Only actions coming from devices of this manufacturer are included in the metric calculation.

The EQUALS operator applies.

apdexstring

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

The element can hold these values
  • Frustrated
  • Satisfied
  • Tolerating
  • Unknown
osFamilystring

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

Specify the OS ID here.

osVersionstring

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

Specify the OS ID here.

citystring

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

Specify geolocation ID here.

continentstring

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

Specify geolocation ID here.

countrystring

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

Specify geolocation ID here.

regionstring

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

Specify geolocation ID here.

actionDurationFromMillisecondsinteger

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

actionDurationToMillisecondsinteger

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

carrierstring

Only actions coming from this carrier type are included in the metric calculation.

connectionTypestring

Only actions coming from this connection type are included in the metric calculation.

The element can hold these values
  • LAN
  • MOBILE
  • OFFLINE
  • UNKNOWN
  • WIFI
networkTechnologystring

Filter by network technology

ispstring

Only actions coming from this internet service provider are included in the metric calculation.

The EQUALS operator applies.

orientationstring

Only actions coming from devices with this display orientation are included in the metric calculation.

The element can hold these values
  • LANDSCAPE
  • PORTRAIT
  • UNKNOWN
resolutionstring

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

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 } ] }
Related topics
  • Create calculated metrics for mobile applications

    Create calculated metrics as well as custom charts based on calculated metrics for your mobile applications.

  • Create calculated metrics for custom applications

    Create calculated metrics as well as custom charts based on calculated metrics for your custom applications.