Skip to content

Session properties

Each session has standard properties (automatically collected by the SDK), and applications can also send custom session properties.

Overview

Session properties are key-value pairs that can be set during a session.

For a given key, only the latest value is kept for the session. This differs from Events, where multiple events of the same type are stored over time.

Examples

Cognitive3DAnalyticsCore.shared.setSessionProperty(key: "testSession", value: true)

Supported value types include String, Boolean, and Numeric.

Cognitive3DAnalyticsCore.shared.setSessionProperty(key: "myKey1", value: "Jibber Jabber")

Cognitive3DAnalyticsCore.shared.setSessionProperty(key: "myKey2", value: true)

Cognitive3DAnalyticsCore.shared.setSessionProperty(key: "myKey3", value: 42)

Note: session properties are cleared when a session ends.

Participants as session properties

Participant identity is represented as session properties and is useful for filtering/segmenting sessions.

Core fields:

  • name: participant full name
  • participantId: participant unique id
Cognitive3DAnalyticsCore.shared.setParticipantId("11112222")

Cognitive3DAnalyticsCore.shared.setParticipantFullName("Jack Jones")

You can also add participant-scoped custom properties:

Cognitive3DAnalyticsCore.shared.setParticipantProperty(keySuffix: "someAttribute", value: "someValue")

These are sent with keys prefixed by c3d.participant..

intercom If you have a question or any feedback about our documentation please use the Intercom button (purple circle) in the lower right corner of any web page or join our Discord.