Mobile apps metrics API - GET a metric

Gets the definition of the specified calculated mobile apps 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/mobile/{metricKey}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/mobile/{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 format

The CalculatedMobileMetric object

Definition of the calculated metric for mobile or custom app.

Element Type Description
applicationIdentifier string

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

name string

The name of the metric, displayed in the UI.

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

metricType string

The type of the metric.

The metricType element can hold these values.
dimensions CalculatedMobileMetricDimension[]

A list of metric dimensions.

userActionFilter CalculatedMobileMetricUserActionFilter

The CalculatedMobileMetricUserActionFilter object

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

Element Type Description
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.

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.

userActionName string

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

The EQUALS operator applies.

appVersion string

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

The EQUALS operator applies.

device string

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

The EQUALS operator applies.

manufacturer string

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

The EQUALS operator applies.

apdex string

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

The apdex element can hold these values.
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.

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.

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.

carrier string

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

connectionType string

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

The connectionType element can hold these values.
networkTechnology string

Filter by network technology

isp string

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

The EQUALS operator applies.

orientation string

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

The orientation element can hold these values.
resolution string

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

The resolution element can hold these values.

The CalculatedMobileMetricDimension object

Dimension of the calculated mobile metric.

Element Type Description
topX integer

The number of top values to be calculated.

dimension string

The dimension of the metric.

The dimension element can hold these values.

Possible values

Possible values for the resolution element in the CalculatedMobileMetricUserActionFilter object:

  • 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

Possible values for the orientation element in the CalculatedMobileMetricUserActionFilter object:

  • LANDSCAPE
  • PORTRAIT
  • UNKNOWN

Possible values for the connectionType element in the CalculatedMobileMetricUserActionFilter object:

  • LAN
  • MOBILE
  • OFFLINE
  • UNKNOWN
  • WIFI

Possible values for the apdex element in the CalculatedMobileMetricUserActionFilter object:

  • Frustrated
  • Satisfied
  • Tolerating
  • Unknown

Possible values for the dimension element in the CalculatedMobileMetricDimension object:

  • APP_VERSION
  • DEVICE
  • ERROR_CONTEXT
  • GEOLOCATION
  • MANUFACTURER
  • OS

Possible values for the metricType element in the CalculatedMobileMetric object:

  • REPORTED_ERROR_COUNT
  • USER_ACTION_DURATION
  • WEB_REQUEST_COUNT
  • WEB_REQUEST_ERROR_COUNT