Mobile and custom app API - GET an app

Gets parameters of the specified mobile or custom app.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applications/mobile/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/applications/mobile/{id}

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
idstring

The ID of the required mobile or custom application.

pathrequired

Response

Response codes

CodeTypeDescription
200MobileCustomAppConfig

Success

404-

Failed. The specified entity doesn't exist.

Response body objects

The MobileCustomAppConfig object

Configuration of an existing mobile or custom application.

ElementTypeDescription
apdexSettingsMobileCustomApdex

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

applicationIdstring

The UUID of the application.

It is used only by OneAgent to send data to Dynatrace.

applicationTypestring

The type of the application.

  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION
beaconEndpointTypestring

The type of the beacon endpoint.

  • CLUSTER_ACTIVE_GATE
  • ENVIRONMENT_ACTIVE_GATE
  • INSTRUMENTED_WEB_SERVER
beaconEndpointUrlstring

The URL of the beacon endpoint.

Only applicable when the beaconEndpointType is set to ENVIRONMENT_ACTIVE_GATE or INSTRUMENTED_WEB_SERVER.

costControlUserSessionPercentageinteger

The percentage of user sessions to be analyzed.

iconTypestring

Custom application icon.

Mobile apps always use the mobile device icon, so this icon can only be set for custom apps.

  • AMAZON_ECHO
  • DESKTOP
  • EMBEDDED
  • IOT
  • MICROSOFT_HOLOLENS
  • UFO
  • USERS
identifierstring

The Dynatrace entity ID of the application.

namestring

The name of the application.

optInModeEnabledboolean

The opt-in mode is enabled (true) or disabled (false).

This value is only applicable to mobile and not to custom apps.

sessionReplayEnabledboolean

The session replay is enabled (true) or disabled (false). This value is only applicable to mobile and not to custom apps.

sessionReplayOnCrashEnabledboolean

Deprecated. Please use sessionReplayEnabled to enable or disable session replay for mobile apps.

The MobileCustomApdex object

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

ElementTypeDescription
frustratedOnErrorboolean

Apdex error condition: if true the user session is considered frustrated when an error is reported.

frustratingThresholdinteger

Apdex frustrated threshold, in milliseconds: a duration greater than or equal to this value is considered frustrated.

toleratedThresholdinteger

Apdex tolerable threshold, in milliseconds: a duration greater than or equal to this value is considered tolerable.

Response body JSON model

{
"apdexSettings": {
"frustratedOnError": true,
"frustratingThreshold": 1,
"toleratedThreshold": 1
},
"applicationId": "string",
"applicationType": "CUSTOM_APPLICATION",
"beaconEndpointType": "CLUSTER_ACTIVE_GATE",
"beaconEndpointUrl": "string",
"costControlUserSessionPercentage": 1,
"iconType": "AMAZON_ECHO",
"identifier": "string",
"name": "string",
"optInModeEnabled": true,
"sessionReplayEnabled": true,
"sessionReplayOnCrashEnabled": true
}