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}

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
id string

The ID of the required mobile or custom application.

path required

Response

Response codes

Code Description
200

Success

404

Failed. The specified entity doesn't exist.

Response body

The MobileCustomAppConfig object

Configuration of a mobile or custom application.

Element Type Description
identifier string

The Dynatrace entity ID of the application.

name string

The name of the application.

applicationType string

The type of the application.

The applicationType element can hold these values.
applicationId string

The UUID of the application.

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

iconType string

The icon of the custom application.

Mobile applications always use the mobile phone icon`.

The iconType element can hold these values.
costControlUserSessionPercentage integer

The percentage of user sessions to be analyzed.

apdexSettings MobileCustomApdex
optInModeEnabled boolean

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

sessionReplayOnCrashEnabled boolean

The session replay on crash is enabled (true) or disabled (false).

beaconEndpointType string

The type of the beacon endpoint.

The beaconEndpointType element can hold these values.
beaconEndpointUrl string

The URL of the beacon endpoint.

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

The MobileCustomApdex object

Apdex configuration of a mobile or custom application.

A duration less than the tolerable threshold is considered satisfied.

Element Type Description
toleratedThreshold integer

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

frustratingThreshold integer

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

frustratedOnError boolean

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

Possible values

Possible values for the beaconEndpointType element in the MobileCustomAppConfig object:

  • CLUSTER_ACTIVE_GATE
  • ENVIRONMENT_ACTIVE_GATE
  • INSTRUMENTED_WEB_SERVER

Possible values for the iconType element in the MobileCustomAppConfig object:

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

Possible values for the applicationType element in the MobileCustomAppConfig object:

  • CUSTOM_APPLICATION
  • MOBILE_APPLICATION