Mobile and custom app API - PUT user session property

Updates the specified user session property in an application.

If the session property with the specified ID does not exist, a new session property is created.

The request consumes and produces an application/json payload.

PUTSaaShttps://{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 WriteConfig scope.

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

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

path
required
body

The JSON body of the request. Contains the configuration of the property.

body
optional

Request body objects

The MobileSessionUserActionPropertyUpd object

An update of a mobile session or user action property.

Element
Type
Description
Required
aggregation
string

The aggregation type of the property.

It defines how multiple values of the property are aggregated.

  • AVERAGE
  • FIRST
  • LAST
  • MAX
  • MIN
  • SUM
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
displayName
string

The display name of the property.

optional
name
string

The name of the reported value.

Only applicable when the origin is set to API.

optional
origin
string

The origin of the property

  • API
  • SERVER_SIDE_REQUEST_ATTRIBUTE
required
serverSideRequestAttribute
string

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

optional
storeAsSessionProperty
boolean

If true, the property is stored as a session property

optional
storeAsUserActionProperty
boolean

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

optional
type
string

The data type of the property.

  • DOUBLE
  • LONG
  • STRING
required

Request body JSON model

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

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

Response

Response codes

Code
Type
Description
201

Success. The property has been created. The response contains the ID of the new property.

204
-

Success. The property has been updated. The response doesn't have a body.

400

Failed. The input is invalid.

Response body objects

The MobileSessionUserActionPropertyShort object

A short representation of mobile session or user action property.

Element
Type
Description
displayName
string

The display name of the session or user action property.

key
string

The key of the session or user action property.

Response body JSON model

{
  "displayName": "string",
  "key": "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.

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

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code
Type
Description
204
-

Success. The submitted configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid.