Mobile and custom app API - POST user session property

Creates a new user session property in the specified application.

The request consumes and produces an application/json payload.

POST

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

Authentication

To execute this request, you need the Write configuration (WriteConfig) 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	required
body	MobileSessionUserActionProperty	The JSON body of the request. Contains the configuration of the property.	body	optional

Body format

Request parametersJSON model

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

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

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

Response

Response codes

Code	Description
201	Success. The property has been created. The response contains the ID of the new property.
400	Failed. The input is invalid.

Response body

Response parametersJSON model

The MobileSessionUserActionPropertyShort object

A short representation of mobile session or user action property.

Element	Type	Description
key	string	The key of the session or user action property.
displayName	string	The display name of the session or user action property.

    {
  "key": "string",
  "displayName": "string"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.