Getting started with the Segmentation Service API getting-started
ÃÛ¶¹ÊÓƵ Experience Platform Segmentation Service allows you to create audiences through segment definitions or other sources in ÃÛ¶¹ÊÓƵ Experience Platform from your Real-Time Customer Profile data.
The developer guide requires a working understanding of the various Experience Platform services involved with using Segmentation Service.
- ÃÛ¶¹ÊÓƵ Experience Platform Segmentation Service: Allows you to build audiences from Real-Time Customer Profile data.
- Experience Data Model (XDM) System: The standardized framework by which Experience Platform organizes customer experience data. To best make use of Segmentation, please ensure your data is ingested as profiles and events according to the best practices for data modeling.
- Real-Time Customer Profile: Provides a unified, real-time consumer profile based on aggregated data from multiple sources.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.
The following sections provide additional information that you will need to know in order to successfully work with the Segmentation API.
Reading sample API calls
The Segmentation Service API documentation provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.
Required headers
The API documentation also requires you to have completed the in order to successfully make calls to Platform endpoints. Completing the authentication tutorial provides the values for each of the required headers in Experience Platform API calls, as shown below:
- Authorization:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place:
- x-sandbox-name:
{SANDBOX_NAME}
Next steps
To being making calls using the Segmentation Service API, select one of the available endpoint guides either using the left navigation or within the developer guide overview