Standard Session Data
Every Session automatically records standard data about the interface being used to access the application. This includes things like the timezone associated with the device and the dimensions of the web browser (if applicable). Standard Session Data is collected in four different namespaces:
browsersessionprofilechannels
The data automatically collected here can be used throughout a Session to further customize the application flow for each device and user.
Standard Session Data
Browser namespace
| Variable | Variable Type | Description | Scope Availability | Additional Notes |
|---|---|---|---|---|
browser.width | number | Device width in pixels | Web Only | These variables can be used with some Airscript to dynamically change styling components |
browser.height | number | Device height in pixels | Web Only | These variables can be used with some Airscript to dynamically change styling components |
Session namespace
| Variable | Variable Type | Description | Scope Availability | Additional Notes |
|---|---|---|---|---|
session.id | string | The unique Airkit-assigned Journey identifier | Global | This identifier (or a customer identifier) is necessary when creating App APIs |
session.timeZone | string | Timezone of the users device | Web Only | This is useful to enable TCPA |
session.locale | string | Locale of the users device | Web Only | This provides you a sense of the users language. This can be helpful if you are building a localized experience. |
session.start.queryParams | object | Query parameters added to the end of a web link | Web Only | Query parameters can be added to the end of a web link and accessible to the builder. For example if you have the web link https://app.airkit.com/l/helloworld?id=1234, you can access the id through session.start.queryParams.id. |
Profile namespace
| Variable | Variable Type | Description | Scope Availability |
|---|---|---|---|
profile.app-auth-type | string | App authentication type of the current profile | Global |
profile.app-authentication-method | string | App authentication method of the current profile | Global |
profile.base-domain | string | Base domain of the current profile | Global |
profile.canvas-link-length | number | Length of the link of the current profile | Global |
profile.canvas-title | string | Title of the current profile | Global |
profile.datastore | object | Datastore for the current profile | Global |
profile.encryption-key | string | Key encryption associated to the current profile | Global |
profile.environment | string | Environment of the current profile | Global |
profile.locale | string | Language and timezone for the current profile | Global |
profile.oauth-configuration | object | OAuth configuration of the current profile | Global |
profile.org-auth-user-saml | boolean | SAML user authentication of the current profile | Global |
profile.session-expiration-time | object | Expiration time of the current profile | Global |
Channels namespace
| Variable | Variable Type | Description | Scope Availability | Additional Notes | |
|---|---|---|---|---|---|
channels.web.url | string | The unique URL to the customer’s journey. | Global | Can be included in SMS to transfer customers from SMS to the Web Channel | |
channels.voice.identifier | string | The user's phone number | Global (After Actor Configuration) | ||
channels.message.identifier | string | The user's phone number | Global (After Actor Configuration) | ||
channels.web.connectedClients | list | Stores when a client connects to the session | Global | List of clients connected to the session | |
channels.web.connectedClients.ipAddress | string | The client IP address | Global | ||
channels.web.connectedClients.connectedTime | dateTime | The client connected time | Global | clients connected to the session |
channels.web.canvasLinkDeprecationIn CXR v18.0,
channels.web.canvasLinkhas been deprecated and being replaced withchannels.web.url.
Additional Configuration Variables
In addition to the Standard Session Data, theme variants and configuration properties are also available using the theme and configuration namespaces, respectively. We recommend exploring namespaces in App Preview to further see the available data.
Updated over 1 year ago