Sending guest data
Sitecore CDP enables you to manage guest data using the following APIs:
-
Stream API - Use to capture guest, behavioral, and order data in real-time, as the guest navigates your application.
NoteTo capture data in JavaScript or TypeScript web applications, we recommend that you use the Cloud SDK or the Engage SDK. These SDKs use the Stream API behind the scenes and let you easily capture data in your web app. Use the Cloud SDK if you have a JSS Next.js or JSS Angular application connected to XM Cloud. Use the Engage SDK in other JavaScript applications.
Sitecore CDP provides events that you can use to capture guest data. Whether it's related to order information or tracking data, it's all captured and visible in the guest profile.
Your organization can send additional, custom data with an event and use that data in batch segmentation and audience exports, just like you can with other event data. If you have Sitecore Personalize, you can also use the data in real-time personalization and decisioning.
-
Batch API - Use to create, update, and delete guest profiles in Sitecore CDP. This API is commonly used to upload large amounts of guest data in an efficient manner when integrating Sitecore CDP with your application. For example, you might decide to load the last 12 months of customer data from your legacy system before going live with Sitecore CDP. To ensure that you can view the data in guest profiles and access it in batch segmentation and audience exports, you must model the guest data object for the Batch API.
-
REST API - Use to create and update guest profiles in Sitecore CDP. To ensure that you can view the data in guest profiles and access it in batch segmentation and audience exports, you must model the guest data object for the REST API.
Sending additional guest data using data extensions
The Batch API and the REST API let you send additional guest data to Sitecore CDP that isn't part of the guest data model.
You can send additional data using a data extension. A data extension is an array that enables you to specify whatever key-value pairs (attributes) your organization wants. This lets your organization capture more robust information about the guest.
You can send additional data using a guest data extension in one of two ways:
-
If you use the Batch API, follow the Batch API guidelines for sending additional guest data. Make sure to format the data according to the guest extension data model.
-
If you use the REST API, create a guest data extension.
After capturing additional guest data using a guest data extension, the data becomes available in Sitecore CDP. You can:
-
View the data extensions associated with a guest in the guest profile, on the Properties tab.
-
Use the data extensions in batch segmentation. See also an example of how guest data extensions display in batch segmentation.
-
Include the extension data in audience exports.