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.

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

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
applicationId	string	The ID of the required application.	path	optional
key	string	The key of the required mobile session or user action property.	path	optional

Response

Response codes

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

Response body objects

The `MobileSessionUserActionProperty` object

Configuration of the mobile session or user action property.

Element	Type	Description	Required
key	string	The unique key of the mobile session or user action property.	required
displayName	string	The display name of the property.	optional
type	string	The data type of the property. The element can hold these values `DOUBLE` `LONG` `STRING`	required
origin	string	The origin of the property The element can hold these values `API` `SERVER_SIDE_REQUEST_ATTRIBUTE`	required
aggregation	string	The aggregation type of the property. It defines how multiple values of the property are aggregated. The element can hold these values `AVERAGE` `FIRST` `LAST` `MAX` `MIN` `SUM`	optional
storeAsUserActionProperty	boolean	If `true`, the property is stored as a user action property	optional
storeAsSessionProperty	boolean	If `true`, the property is stored as a session property	optional
cleanupRule	string	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.	optional
serverSideRequestAttribute	string	The ID of the request attribute. Only applicable when the origin is set to `SERVER_SIDE_REQUEST_ATTRIBUTE`.	optional
name	string	The name of the reported value. Only applicable when the origin is set to `API`.	optional

Response body JSON model

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