Mobile and custom app API - GET user session property

Gets the parameters of the specified user session property of an app.

The request produces an application/json payload.

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

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
applicationIdstring

The ID of the required application.

pathrequired
keystring

The key of the required mobile session or user action property.

pathrequired

Response

Response codes

CodeTypeDescription
200MobileSessionUserActionProperty

Success

404-

Failed. The specified entity doesn't exist.

Response body objects

The MobileSessionUserActionProperty object

Configuration of the mobile session or user action property.

ElementTypeDescription
aggregationstring

The aggregation type of the property.

It defines how multiple values of the property are aggregated.

  • AVERAGE
  • FIRST
  • LAST
  • MAX
  • MIN
  • SUM
cleanupRulestring

The cleanup rule of the property.

Defines how to extract the data you need from a string value. Specify the regular expression for the data you need there.

displayNamestring

The display name of the property.

keystring

The unique key of the mobile session or user action property.

namestring

The name of the reported value.

Only applicable when the origin is set to API.

originstring

The origin of the property

  • API
  • SERVER_SIDE_REQUEST_ATTRIBUTE
serverSideRequestAttributestring

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

storeAsSessionPropertyboolean

If true, the property is stored as a session property

storeAsUserActionPropertyboolean

If true, the property is stored as a user action property

typestring

The data type of the property.

  • DOUBLE
  • LONG
  • STRING

Response body JSON model

{
"aggregation": "AVERAGE",
"cleanupRule": "string",
"displayName": "string",
"key": "string",
"name": "string",
"origin": "API",
"serverSideRequestAttribute": "string",
"storeAsSessionProperty": true,
"storeAsUserActionProperty": true,
"type": "DOUBLE"
}