Show Menu
TOPICS×

Segmentation Service developer guide

Segmentation allows you to build segments and generate audiences in Adobe Experience Platform from your Real-time Customer Profile data.

Getting started

This guide requires a working understanding of the various Adobe Experience Platform services involved with using Segmentation.
  • Segmentation : Allows you to build audience segments from Real-time Customer Profile data.
  • Experience Data Model (XDM) System : The standardized framework by which Experience Platform organizes customer experience data.
  • 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 use Segmentation using the 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 authentication tutorial 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: {IMS_ORG}
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}
For more information on working with sandboxes in Experience Platform, see the sandboxes overview documentation .

Segment definitions

Segment definitions define which profiles will be part of which audience segments. You can use the /segment/definitions endpoint to retrieve a list of segment definitions, create a new segment definition, retrieve details of a specific segment definition, delete a specific segment definition, or overwrite details of a specific segment definition.
For more information on using this endpoint, please read the segment definitions developer guide .

Segment jobs

Segment jobs process previously established segment definitions to generate an audience segment. You can use the /segment/jobs endpoint to retrieve a list of segment jobs, create a new segment job, retrieve details of a specific segment job, or delete a specific segment job.
For more information on using this endpoint, please read the segment jobs developer guide .

Next steps

To begin making calls using the Segmentation API, select one of the sub-guides to learn how to use specific Segmentation-related endpoints. To learn more about working with segments using the Platform UI, see the Segmentation user guide .