Skip to main content

Overview of Sitecore CDP Stream APIs


Provides an introduction to the Sitecore CDP Stream APIs (Data model 2.0).

Sitecore CDP (Customer Data Platform) provides a suite of API Services that makes data management easier, faster, and more efficient. The Stream APIs capture fast-flowing, high-velocity event data at the same time that it is generated on your organization's website. The Stream APIs and Boxever JavaScript Library facilitate the capturing of events over web-based applications. Stream APIs can also be deployed in conjunction with your organization's data layer.

The following are the Sitecore CDP Stream APIs:

  • Browser API - the Browser Interface enables you to extend functionality within a web browser or other HTTP client. You can use the Browser Interface to manage cookies in the browser that help identify guests and facilitate personalization.

  • Event API - the Event Interface enables event processing. For example, you can use the Event API to send events in at speed from mobile applications or your website.

The Sitecore CDP Stream APIs have the following characteristics:

  • Support synchronous calls

  • Send write-only data

  • Process structured data

  • Capture online events

  • Facilitate Online Data Capture (ODC)

When to use the Sitecore CDP Stream APIs

Sitecore CDP Stream APIs provide a light-touch integration that facilitate immediate realization of Sitecore CDP functionality. The Sitecore CDP Stream APIs are used for the following purposes:

  • Online data capture - you can integrate the Sitecore CDP Stream APIs with your data layer to capture guest activity as guests navigate your online booking flow. Sitecore CDP can also integrate with your website, mobile app, and call center.

  • Website personalization - your organization's web-based application can pass guest, behavioral, and transactional data to Sitecore CDP to use in real-time decisioning and experiment execution.

  • Behavioral information - the Event API captures a guest's behavioral data that can immediately be used in real-time personalization. For example, the pages the guest visits, the searches the guest performs, purchased products, and products added to the cart but not purchased.

  • Optimizes Sitecore CDP Decisioning - the Stream APIs capture behavioral and transactional data to ensure that Sitecore CDP Decisioning has the most up-to-date guest, order, and search data for use in personalization and experiments.