Mobile and custom app API - GET an app

Gets parameters of the specified mobile or custom app.

The request produces an application/json payload.

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

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
id	string	The ID of the required mobile or custom application.	path	required

Response

Response codes

Code	Type	Description
200	MobileCustomAppConfig	Success
404	-	Failed. The specified entity doesn't exist.

Response body objects

The `MobileCustomAppConfig` object

Configuration of an existing mobile or custom application.

Element	Type	Description	Required
identifier	string	The Dynatrace entity ID of the application.	optional
name	string	The name of the application.	required
applicationType	string	The type of the application. The element can hold these values `CUSTOM_APPLICATION` `MOBILE_APPLICATION`	optional
applicationId	string	The UUID of the application. It is used only by OneAgent to send data to Dynatrace.	optional
iconType	string	Custom application icon. Mobile apps always use the mobile device icon, so this icon can only be set for custom apps. The element can hold these values `AMAZON_ECHO` `DESKTOP` `EMBEDDED` `IOT` `MICROSOFT_HOLOLENS` `UFO` `USERS`	optional
costControlUserSessionPercentage	integer	The percentage of user sessions to be analyzed.	required
apdexSettings	MobileCustomApdex	Apdex configuration of a mobile or custom application. A duration less than the tolerable threshold is considered satisfied.	required
optInModeEnabled	boolean	The opt-in mode is enabled (`true`) or disabled (`false`). This value is only applicable to mobile and not to custom apps.	optional
sessionReplayEnabled	boolean	The session replay is enabled (`true`) or disabled (`false`). This value is only applicable to mobile and not to custom apps.	optional
sessionReplayOnCrashEnabled	boolean	Deprecated. Please use `sessionReplayEnabled` to enable or disable session replay for mobile apps.	optional
beaconEndpointType	string	The type of the beacon endpoint. The element can hold these values `CLUSTER_ACTIVE_GATE` `ENVIRONMENT_ACTIVE_GATE` `INSTRUMENTED_WEB_SERVER`	required
beaconEndpointUrl	string	The URL of the beacon endpoint. Only applicable when the beaconEndpointType is set to `ENVIRONMENT_ACTIVE_GATE` or `INSTRUMENTED_WEB_SERVER`.	optional

The `MobileCustomApdex` object

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

Element	Type	Description	Required
toleratedThreshold	integer	Apdex tolerable threshold, in milliseconds: a duration greater than or equal to this value is considered tolerable.	required
frustratingThreshold	integer	Apdex frustrated threshold, in milliseconds: a duration greater than or equal to this value is considered frustrated.	required
frustratedOnError	boolean	Apdex error condition: if `true` the user session is considered frustrated when an error is reported.	required

Response body JSON model

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