Mobile app metrics API - POST a metric

Creates a new calculated mobile app metric.

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/mobile

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
body CalculatedMobileMetric

The JSON body of the request. Contains the definition of the new calculated metric for mobile or custom app.

body optional

Body format

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.

required
dimensions CalculatedMobileMetricDimension[]

A list of metric dimensions.

optional
userActionFilter CalculatedMobileMetricUserActionFilter optional

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.

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.

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.

optional
resolution string

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

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.

required

Response

Response codes

Code Description
201

Success. The calculated mobile metric has been created. Response contains its key and name.

400

Failed. The input is invalid

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/mobile/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/mobile/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

Validated. The submitted metric is valid. The response doesn't have a body.

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.