Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
PersonalizeCloud Portal
Sitecore Personalize developer documentation
  • Developing with Sitecore Personalize
        • Authentication
        • Base URL
        • Retrieve the browser ID
                • Session data
                • Tracking data
            • IDENTITY event
            • SEARCH event
            • ADD event
            • ADD event for flights
            • ADD event for ancillary product
            • ADD_CONSUMERS event
            • ADD_CONTACTS event
            • CONFIRM event
            • CONFIRM event for flights
            • CHECKOUT event
            • ORDER_CHECKOUT event
            • CLEAR_CART event
            • PAYMENT event
            • Custom event
        • Sending orders
        • Cart abandonment
        • Send additional event data
        • Troubleshooting
  1. VIEW event
  1. Sitecore Personalize developer documentation
  2. Stream API

Session data

You can capture session data in an event that is triggered in the session, for example, a VIEW event or an ADD event. To pass session data in a custom-made deep link, place the deep link in the object.

AttributeTypeDescriptionExampleRequired/optional
session_dataJSON objectJSON Object An object of arbitrary session data.N/ARequired
session_data.attributeAny of the following:

  • string
  • boolean
  • integer
  • float
One or many name/value pair attributes for custom session data."is_logged_in":trueOptional

Example 35. Session data

{
    "channel": "MOBILE_APP",
    "type": "VIEW",
    "language": "EN",
    "currency": "EUR",
    "page": "home page",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "session_data": {
        "deep_link": "https://www.retailsite123.com/search?product=shoes",
        "is_logged_in": true,
        "assistance": false
     }
}
If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use