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.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/applications/mobile/{applicationId}/userActionAndSessionProperties/{key}
  • SaaS https://{your-environment-id}{applicationId}/userActionAndSessionProperties/{key}


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.


Parameter Type Description In Required
applicationId string

The ID of the required application.

path required
key string

The key of the required session property.

path required


Response codes

Code Description



Failed. The specified entity doesn't exist.

Response body

The MobileSessionProperty object

Configuration of the mobile session property.

Element Type Description
key string

The unique key of the session property.

displayName string

The display name of the property.

type string

The data type of the property.

origin string

The origin of the property

aggregation string

The aggregation type of the property.

It defines how multiple values of the property are aggregated.

storeAsUserActionProperty boolean

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

storeAsSessionProperty boolean

If true, the property is stored as a session property

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.

serverSideRequestAttribute string

The ID of the request attribute.

Only applicable when the origin is set to SERVER_SIDE_REQUEST_ATTRIBUTE.

name string

The name of the reported value.

Only applicable when the origin is set to API.