# cdp-api All of the CDP APIs are organized around REST - if you've interacted with a RESTful API already, many of the concepts will be familiar to you. All API calls to CDP API should be made to the following endpoints depending on the [region](https://docs.treasuredata.com/display/public/PD/Sites+and+Endpoints#SitesandEndpoints-Endpoints). For historical reasons there are REST API endpoints and JSON:API endpoints. JSON:API endpoints are located under "/entities". Version: 1.0.0 ## Servers ``` https://api-cdp.treasuredata.com ``` ``` https://api-cdp.treasuredata.co.jp ``` ``` https://api-cdp.eu01.treasuredata.com ``` ``` https://api-cdp.ap02.treasuredata.com ``` ``` https://api-cdp.ap03.treasuredata.com ``` ## Security ### TdApikeyAuth Type: apiKey In: header Name: Authorization ## Download OpenAPI description [cdp-api](https://td-public.redocly.app/_spec/apis/td_cdp_api-public.yaml) ## Parent Segment Configurations Defining a data model for customer data is done by defining parent segments. Parent segments give you an ability to build a single view of a customer, including capturing all interactions, such as attributes and behaviors associated with your brand. In parent segments, you unify your customer data. When the customer data is unified, you can create customer segments without writing any SQL queries. You can personalize customer communications and conversations of any size and in any channel.


_Treasure Data is making an effort to use more inclusive language in its product, content, and customer solutions. As we gradually make the move to replace insensitive language beginning in our UI, you may continue to see parent segments in the UI, for example, referenced as master segment in portions of Treasure Data APIs._ ### Retrieve list of parent segment configurations - [GET /audiences](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_index.md): Retrieve a list of parent segment configurations by name. You can get the parent segment's schedules, created_by, the parent database name and tables, its attributes and behaviors, as well as the population for the retrieved Parent Segment. ### Create new parent segment configuration - [POST /audiences](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_create.md): Create a new parent segment configuration. ### Retrieve parent segment configuration by ID - [GET /audiences/{audienceId}](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_show.md): Search and find a specified parent segment configuration by its identifier. ### Update parent segment configuration - [PUT /audiences/{audienceId}](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_update.md): Update the specified parent segment configuration by its identifier. ### Delete parent segment configuration - [DELETE /audiences/{audienceId}](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_delete.md): Delete a previously created parent segment configuration. ### Retrieve list of audience attributes - [GET /audiences/{audienceId}/attributes](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audience_attributes_index.md): Retrieve a list of parent segment attributes. You can also specify the visibility level for sensitive attributes. ### Retrieve list of audience behaviors - [GET /audiences/{audienceId}/behaviors](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audience_behaviors_index.md): Retrieve a list of parent segment behaviors. ### Run workflow to (re)generate parent segment - [POST /audiences/{audienceId}/run](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_run.md): Run the workflow to generate or regenerate a parent segment. ### Retrieve list of executions using audienceId - [GET /audiences/{audienceId}/executions](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_executions.md): Retrieve a list of workflow executions, whether they were succesful or not, and their status. ### Retrieve population statistics audience - [GET /audiences/{audienceId}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_statistics.md): Retrieve the population history of the audience. The history is returned per day and those days are calculated in the timezone of the audience. ### Retrieve list of values for a parent segment configuration's attribute - [GET /audiences/{audienceId}/sample_values](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_sample_values.md): Retrieve a list of sample values associated with the attributes of a parent segment configuration. ### Retrieve list of sample values for a parent segment configuration's behavior - [GET /audiences/{audienceId}/behaviors/{audienceBehaviorId}/sample_values](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segment-configurations/audiences_behaviors_sample_values.md): Retrieve a list of sample values for a parent segment's behavior that are useful in understanding data syntax or patterns for further analysis or activation. ## Parent Segments After you have created the parent segment, you can view data about the parent segment, such as details about a single segment, audience data, the list of segment folders it contains, or a list of parent segments available. ### Retrieve list of segment folders - [GET /audiences/{audienceId}/folders](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segments/paths/~1audiences~1%7Baudienceid%7D~1folders/get.md): Retrieve a list of segment folders based on a parent segment's identifier. ### Retrieve audience data - [GET /master_segments](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segments/paths/~1master_segments/get.md): Retrieve the audiences for which the current user can view its produced data e.g. segments, profiles, activations. ### Retrieve list of parent segments - [GET /entities/parent_segments](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segments/paths/~1entities~1parent_segments/get.md): Retrieve a list of parent segments. ### Retrieve parent segment by ID - [GET /entities/parent_segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/parent-segments/paths/~1entities~1parent_segments~1%7Bid%7D/get.md): Retrieve an parent segment by ID. ## Segments In marketing, a segment is a container that groups profiles (usually people) who share one or more common characteristics. In Treasure Data, the parent segment is your total population of people, accounts, or other type of collection and can be both existing and potential customers.

You create segments to divide the population into subgroups of consumers based on some type of shared characteristics. Segments and subsegments enable more specific targeting for your marketing campaigns.


_Treasure Data is making an effort to use more inclusive language in its product, content, and customer solutions. As we gradually make the move to replace insensitive language beginning in our UI, you may continue to see parent segments in the UI, for example, referenced as master segment in portions of Treasure Data APIs._ ### Retrieve list of segments - [GET /audiences/{audienceId}/segments](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_index.md): Retrieve a list of segments. ### Create new segment - [POST /audiences/{audienceId}/segments](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_create.md): Create a new segment. ### Retrieve list of segments in a folder - [GET /audiences/{audienceId}/folders/{folderId}/segments](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segment_folders_segments.md): Retrieve a list of segments in a folder. ### Retrieve SQL from segment rule - [POST /audiences/{audienceId}/segments/query](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_query.md): Retrieve a SQL from a segment rule. ### Retrieve number of profiles based on set of segment rules - [POST /audiences/{audienceId}/segments/queries](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_new_query.md): Retrieve the number of profiles produced by a set of segment rules. ### Retrieve segment by ID - [GET /audiences/{audienceId}/segments/{segmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_show.md): Retrieve a segment based on its identifier. ### Update segment - [PUT /audiences/{audienceId}/segments/{segmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_update.md): Update a segment. ### Delete segment (legacy) - [DELETE /audiences/{audienceId}/segments/{segmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_delete.md): Delete a segment. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve status of query - [GET /audiences/{audienceId}/segments/queries/{queryId}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_query_status.md): Retrieve the status of a query. ### Kill current running query of segment - [POST /audiences/{audienceId}/segments/queries/{queryId}/kill](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_kill_query.md): Kill the current running query associated with the segment. ### Retrieve profiles of query - [GET /audiences/{audienceId}/segments/queries/{queryId}/customers](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_index_query_customers.md): Retrieve the profiles of a query. ### Retrieve population statistics of segment - [GET /audiences/{audienceId}/segments/{segmentId}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/segments/segments_statistics.md): Retrieve the population history of the segment. The history is returned per day and those days are calculated in the timezone of the audience. Note that funnel_stage kind doesn't have statistics via this endpoint. ### Create segment - [POST /entities/segments](https://td-public.redocly.app/apis/td_cdp_api-public/segments/paths/~1entities~1segments/post.md): Create a new segment. ### Retrieve segment by ID - [GET /entities/segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/paths/~1entities~1segments~1%7Bid%7D/get.md): Retrieve a segment by ID. ### Update segment - [PATCH /entities/segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/paths/~1entities~1segments~1%7Bid%7D/patch.md): Update a segment. ### Delete segment - [DELETE /entities/segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/segments/paths/~1entities~1segments~1%7Bid%7D/delete.md): Delete a segment. ## Folders Folders are containers in which you can organize information. Nested folders offer flexible organization controls. Large volumes of data and application assets can be organized into multi-nested folders by categories such as geographical markets, brands, and business functions. Granular permissions can be set for each folder to ensure security. ### Create new segment folder - [POST /audiences/{audienceId}/folders](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1audiences~1%7Baudienceid%7D~1folders/post.md): Create a new parent segment folder. ### Retrieve single segment folder - [GET /audiences/{audienceId}/folders/{folderId}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1audiences~1%7Baudienceid%7D~1folders~1%7Bfolderid%7D/get.md): Retrieve a single segment folder based on a parent segment identifier. ### Update segment folder (legacy) - [PATCH /audiences/{audienceId}/folders/{folderId}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1audiences~1%7Baudienceid%7D~1folders~1%7Bfolderid%7D/patch.md): Update a segment folder. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Delete segment folder (legacy) - [DELETE /audiences/{audienceId}/folders/{folderId}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1audiences~1%7Baudienceid%7D~1folders~1%7Bfolderid%7D/delete.md): Delete a segment folder. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Move segment into folder (legacy) - [POST /audiences/{audienceId}/folders/{folderId}/put_in](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1audiences~1%7Baudienceid%7D~1folders~1%7Bfolderid%7D~1put_in/post.md): Move a segment or segments into an existing folder. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve list of objects under specified folder - [GET /entities/by-folder/{folderId}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1entities~1by-folder~1%7Bfolderid%7D/get.md): Retrieve a list of objects under a specified folder, including child folders, segments, batch segments, predictive scoring models, funnels, Profile API tokens and Journeys. ### Create folder - [POST /entities/folders](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1entities~1folders/post.md): Create a new folder. ### Retrieve folder by ID - [GET /entities/folders/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1entities~1folders~1%7Bid%7D/get.md): Retrieve a folder by ID. ### Update folder - [PATCH /entities/folders/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1entities~1folders~1%7Bid%7D/patch.md): Update a folder by ID. ### Delete folder - [DELETE /entities/folders/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/folders/paths/~1entities~1folders~1%7Bid%7D/delete.md): Delete a folder by ID. ## Activations Activation is the process that allows marketers to personalize communication to users interested in your brand.

_Known formerly as syndication in Audience Studio Legacy. You may continue to see syndication referenced in Treasure Data APIs._ ### Retrieve list of activations recursively under a folder - [GET /audiences/{audienceId}/folders/{folderId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/segment_folders_syndications.md): Retrieve a list of activations (formerly syndications) recursively under a folder. ### Retrieve list of activations in segment - [GET /audiences/{audienceId}/segments/{segmentId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_index.md): Retrieve a list of activations (formerly syndications) associated with a segment. ### Create activation - [POST /audiences/{audienceId}/segments/{segmentId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_create.md): Create a new activation (formerly syndication). ### Retrieve activation by ID - [GET /audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_show.md): Retrieve an activation (formerly syndication) based on its identifier. ### Update activation - [PUT /audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_update.md): Update an activation (formerly syndication). ### Delete activation - [DELETE /audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_delete.md): Delete an activation (formerly syndication). ### Run activation (legacy) - [POST /audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}/run](https://td-public.redocly.app/apis/td_cdp_api-public/activations/syndications_run.md): Run an activation (formerly syndication). _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve list of activations in audience - [GET /audiences/{audienceId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/audience_syndications_index.md): Retrieve a list of activations (formerly syndications) associated with a parent segment ID and view their status and/or schedules. ### Retrieve list of activations - [GET /entities/segments/{segmentId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/activation_index.md): Retrieve a list of activations for a particular segment ID. ### Create activation - [POST /entities/segments/{segmentId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/activation_create.md): Create an activation (formerly syndication). ### Retrieve list of activations - [GET /entities/segments/{segmentId}/syndications/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/activation_show.md): Retrieve a list of activations for a segment ID. ### Update activation - [PATCH /entities/segments/{segmentId}/syndications/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/activation_update.md): Update an activation. ### Delete activation - [DELETE /entities/segments/{segmentId}/syndications/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activations/activation_delete.md): Delete an activation. ### Run activation - [POST /entities/segments/{segmentId}/syndications/{id}/run](https://td-public.redocly.app/apis/td_cdp_api-public/activations/paths/~1entities~1segments~1%7Bsegmentid%7D~1syndications~1%7Bid%7D~1run/post.md): Run an activation by specifying its ID and segment ID. ### Retrieve list of activations by parent segment - [GET /entities/parent_segments/{parentSegmentId}/syndications](https://td-public.redocly.app/apis/td_cdp_api-public/activations/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1syndications/get.md): Retrieve a list of activations based on a parent segment. ### List of workflow project names - [GET /entities/parent_segments/{parentSegmentId}/user_defined_workflow_projects](https://td-public.redocly.app/apis/td_cdp_api-public/activations/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1user_defined_workflow_projects/get.md): Returns a list of workflow project names ### List of workflow names - [GET /entities/parent_segments/{parentSegmentId}/user_defined_workflows](https://td-public.redocly.app/apis/td_cdp_api-public/activations/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1user_defined_workflows/get.md): Returns a list of workflow names ## Tokens The Profiles API Token enables your ability to increase personalized content based on detailed customer information. This REST API returns customer data in real-time and updates your segment information. The ability to create a Profiles API token is based on your folder permissions.

You can also use Profiles API Token to personalize your customers' experience on your website. You can combine Treasure Data’s personalization feature with A/B Testing tools such as Adobe Target, Optimizely, or Google Optimize, to determine the version of your website that yields results.

When the underlying personalization workflow completes, the personalization data set is refreshed. You can see a current list of the segments to which a specific profile belongs. You can also see a list of attributes associated with the specific profile.

The parent segment must already exist. The parent segment is the basis for all data accessed by Profiles API Tokens.

The use of the Profiles API Token with your tools requires the use of the Treasure Data JavaScript SDK and support or services consultation. ### Retrieve list of Profile API tokens - [GET /audiences/{audienceId}/tokens](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/tokens_index.md): Retrieve a list of Profile API tokens associated with a parent segment ID. ### Create new Profiles API token (legacy) - [POST /audiences/{audienceId}/tokens](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/tokens_create.md): Create a new Profiles API token. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve Profiles API token by ID - [GET /audiences/{audienceId}/tokens/{tokenId}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/tokens_show.md): Retrieve a specific Profiles API token by its identifier. ### Update Profiles API token (legacy) - [PUT /audiences/{audienceId}/tokens/{tokenId}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/tokens_update.md): Update a Profiles API token. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Delete a Profiles API token (legacy) - [DELETE /audiences/{audienceId}/tokens/{tokenId}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/tokens_delete.md): Delete a Profiles API token. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Create Profiles API token - [POST /entities/tokens](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/paths/~1entities~1tokens/post.md): Create a Profiles API token. ### Retrieve Profiles API token by ID - [GET /entities/tokens/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/paths/~1entities~1tokens~1%7Bid%7D/get.md): Retrieve the specified Profiles API token. ### Update Profiles API token - [PATCH /entities/tokens/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/paths/~1entities~1tokens~1%7Bid%7D/patch.md): Update a Profiles API token. ### Delete Profiles API token - [DELETE /entities/tokens/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/tokens/paths/~1entities~1tokens~1%7Bid%7D/delete.md): Delete the specified Profiles API token. ## Funnels One of the challenges of targeting customers with relevant campaigns is understanding where they are in their customer journey. Many organizations use the traditional marketing funnel to understand where their customers are in the buying process. Knowing where customers are in the marketing funnel allows organizations to create campaigns and analyze customer behaviors that are specific to individual customers or customer groups. Being able to use all available customer data to accurately identify exactly in which stage customers are in gives marketers a clear advantage.

Treasure Data offers Funnels, a premium subscription feature in Audience Studio, which provides this advantage to its users. Funnels make it easier for marketers to see exactly where their customers are in the buying process, allowing them to create more customer-tailored marketing campaigns using multi-channel activations.

Funnels enables marketers to create and customize a marketing funnel with up to eight stages in the Audience Studio to reflect the exact buying experience of their customers. After the Funnel stages have been created, marketers can further analyze and refine the stages and activate specific stages for campaigns. ### List of funnels - [GET /audiences/{audienceId}/funnels](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_index.md): Retrieves a list of funnels associated with a parent segment identifier and its stages. ### Create funnel (legacy) - [POST /audiences/{audienceId}/funnels](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_create.md): Create a new funnel, assign it a name and description matching your business needs. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve funnel by ID - [GET /audiences/{audienceId}/funnels/{funnelId}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_show.md): Search and find a specific funnel by its identifier. ### Update funnel (legacy) - [PUT /audiences/{audienceId}/funnels/{funnelId}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_update.md): Update a funnel. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Delete funnel (legacy) - [DELETE /audiences/{audienceId}/funnels/{funnelId}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_delete.md): Delete a funnel. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Clone funnel - [POST /audiences/{audienceId}/funnels/{funnelId}/clone](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_clone.md): Make a copy of a funnel. ### Retrieve the population statistics of a funnel and its funnel stages - [GET /audiences/{audienceId}/funnels/{funnelId}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/funnels_statistics.md): Retrieve the population history of a funnel. The history is returned per day and those days are calculated in the timezone of the audience. ### Create funnel - [POST /entities/funnels](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1funnels/post.md): Create a funnel. ### Retrieve funnel by ID - [GET /entities/funnels/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1funnels~1%7Bid%7D/get.md): Retrieve a funnel by ID. ### Update funnel - [PATCH /entities/funnels/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1funnels~1%7Bid%7D/patch.md): Update a funnel. ### Delete funnel - [DELETE /entities/funnels/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1funnels~1%7Bid%7D/delete.md): Delete a funnel. ### Retrieve population statistics of funnel stage - [GET /entities/funnels/{funnelId}/stages/{id}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1funnels~1%7Bfunnelid%7D~1stages~1%7Bid%7D~1statistics/get.md): Retrieve the population history of the audience. The history is returned per day and those days are calculated in the timezone of the audience. ### Retrieve list of funnel by parent segment - [GET /entities/parent_segments/{parentSegmentId}/funnels](https://td-public.redocly.app/apis/td_cdp_api-public/funnels/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1funnels/get.md): Retrieve a list of funnels based on a parent segment. ## Predictive Segments Using Treasure Data’s predictive scoring model, based on predictive segments, marketers can predict profile behavior such as who is likely to churn, purchase, click, or convert in the near future.

A predictive model is a set of rules that makes it possible to predict an unmeasured value from other, known values. The form of the rules is suggested by reviewing the data collected. Training is then used to make some predictions. Predictive modeling uses statistics to predict outcomes.

Predictive modeling is a typically used statistical technique to predict future behavior. Predictive modeling solutions analyze historical and current data and the generated model helps predict future outcomes. In predictive modeling, data is collected, a statistical model is formulated, predictions are made, and the model is validated (or revised) as additional data becomes available. For example, risk models can be created to combine member information in complex ways with demographic and lifestyle information from external sources to improve underwriting accuracy. Predictive models analyze past performance to assess how likely a customer is to exhibit a specific behavior in the future. This category also encompasses models that seek out subtle data patterns to answer questions about customer performance, such as fraud detection models. Predictive models often perform calculations during live transactions—for example, to evaluate the risk or opportunity of a given customer or transaction to guide a decision.

Treasure Data’s predictive scoring model uses predictive segments to customize predictive scoring models for a particular segment. ### Retrieve list of predictive scoring models - [GET /audiences/{audienceId}/predictive_segments](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/predictive_segments_index.md): Retrieve a list of predictive scoring models in the specified parent segment. ### Create predictive scoring model (legacy) - [POST /audiences/{audienceId}/predictive_segments](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/predictive_segments_create.md): Create a new predictive scoring model. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve predictive scoring model - [GET /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1%7Bpredictivesegmentid%7D/get.md): Retrieve a specific predictive scoring model's statistics. ### Update predictive scoring model (legacy) - [PATCH /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/predictive_segments_update.md): Update a predictive scoring model. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Delete predictive scoring model (legacy) - [DELETE /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/predictive_segments_destroy.md): Delete a predictive scoring model. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve predictive scoring model executions - [GET /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}/executions](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1%7Bpredictivesegmentid%7D~1executions/get.md): Retrieve a list of predictive scoring model executions and their status. ### Retrieve guessed rule - [GET /audiences/{audienceId}/predictive_segments/guess_rule_async](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1guess_rule_async/get.md): Retrieve a list of guessed rules associated with a predictive scoring model. ### Retrieve column list - [GET /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}/model/columns](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1%7Bpredictivesegmentid%7D~1model~1columns/get.md): Retrieve the column list used in a predictive scoring model. ### Retrieve column list of features - [GET /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}/model/features](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1%7Bpredictivesegmentid%7D~1model~1features/get.md): Retrieve features associated with a predictive scoring model. ### Retrieve histogram - [GET /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}/score_histogram](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1audiences~1%7Baudienceid%7D~1predictive_segments~1%7Bpredictivesegmentid%7D~1score_histogram/get.md): Retrieve a histogram of the specified predictive scoring model. ### Train predictive scoring model (legacy) - [POST /audiences/{audienceId}/predictive_segments/{predictiveSegmentId}/run](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/predictivesegment_run.md): Train a predictive scoring model. _This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative._ ### Retrieve predictive scoring rules - [GET /entities/segments/{id}/predictive_segments/guess_rule_async](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1segments~1%7Bid%7D~1predictive_segments~1guess_rule_async/get.md): Retrieve predictive scoring rules. ### Create predictive scoring model - [POST /entities/predictive_segments](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments/post.md): Create a new predictive scoring model. ### Retrieve predictive scording model by ID - [GET /entities/predictive_segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D/get.md): Retrieve a predictive scording model by ID. ### Update predictive scoring model - [PATCH /entities/predictive_segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D/patch.md): Update a predictive scoring model. ### Delete predictive scoring model - [DELETE /entities/predictive_segments/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D/delete.md): Delete a predictive scoring model. ### Run predictive scoring model - [POST /entities/predictive_segments/{id}/run](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D~1run/post.md): Run a predictive scoring model. ### Retrieve executions of predictive scoring model - [GET /entities/predictive_segments/{id}/executions](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D~1executions/get.md): Retrieve executions of the specified predictive scoring model. ### Retrieve features of predictive scoring model - [GET /entities/predictive_segments/{id}/model/features](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D~1model~1features/get.md): Retrieve the list of features used in the specified predictive scoring model. ### Retrieve columns of predictive scoring model - [GET /entities/predictive_segments/{id}/model/columns](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D~1model~1columns/get.md): Retrieve the columns of the specified predictive scoring model. ### Retrieve scores of predictive scoring model - [GET /entities/predictive_segments/{id}/model/score](https://td-public.redocly.app/apis/td_cdp_api-public/predictive-segments/paths/~1entities~1predictive_segments~1%7Bid%7D~1model~1score/get.md): Retrieve the scores of the specified predictive scoring model. ## Journeys In Audience Studio, a journey represents a timeline of events that can help you motivate a customer’s behavior about your product. After marketers create journey stages, they can further analyze and refine the stages and activate specific stages for campaigns.

_Journeys is a premium feature. Contact your Customer Success Representative for more information._ ### List journeys - [GET /entities/journeys](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys/get.md): List journeys under the specified folder. ### Create journey - [POST /entities/journeys](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys/post.md): Create a journey. ### Retrieve summary of specified journey - [GET /entities/journeys/{journeyId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D/get.md): Retrieve the summary of a specified journey. ### Update journey entity - [PATCH /entities/journeys/{journeyId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D/patch.md): Update a journey entity. ### Delete journey entity - [DELETE /entities/journeys/{journeyId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D/delete.md): Delete a journey entity. ### Update meta field - [POST /entities/journeys/{journeyId}/detail](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1detail/post.md): Update the meta field of the journey in draft. ### Retrieve a list of available behavior table of specified step - [POST /entities/journeys/{journeyId}/available_behaviors_for_step](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1available_behaviors_for_step/post.md): Retrieve a list of available behavior table of specified step. ### Retrieve a list of journey activation templates of specified step - [POST /entities/journeys/{journeyId}/activation_templates_for_step](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activation_templates_for_step/post.md): Retrieve a list of journey activation templates of specified step. ### Create a duplicate of the specified journey - [POST /entities/journeys/duplicate](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1duplicate/post.md): Create a duplicate of the specified journey ### Retrieve journey statistics - [GET /entities/journeys/{journeyId}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1statistics/get.md): Retrieve the specified journey statistics. ### Retrieve the list of conversion sankey chart source data - [GET /entities/journeys/{journeyId}/conversion_sankey_charts](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1conversion_sankey_charts/get.md): Retrieve the list of conversion sankey chart source data ### Retrieve the list of activation sankey chart source data - [GET /entities/journeys/{journeyId}/activation_sankey_charts](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activation_sankey_charts/get.md): Retrieve the list of activation sankey chart source data ### Retrieve list of profiles in journey - [GET /entities/journeys/{journeyId}/customers](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1customers/get.md): Retrieve a list of profiles in a journey. ### Retrieve list of segment rules available in audience - [GET /entities/journeys/segment_rules](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1segment_rules/get.md): Retrieve a list of segment rules available in an audience. It returns the viewable journeys only. ### Retrieve list of journey activations in journey - [GET /entities/journeys/{journeyId}/activations](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activations/get.md): Retrieve a list of journey activations for the specified journey. ### Create an activation step in journey - [POST /entities/journeys/{journeyId}/activations](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activations/post.md): Create an activation step in a journey. ### Retrieve summary of activation node in journey - [GET /entities/journeys/{journeyId}/activations/{journeyActivationStepId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activations~1%7Bjourneyactivationstepid%7D/get.md): Retrieve a summary of the activation node in a journey. ### Update the configuration of the activation step in journey - [PATCH /entities/journeys/{journeyId}/activations/{journeyActivationStepId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1activations~1%7Bjourneyactivationstepid%7D/patch.md): Update the configuration of the activation step in journey. ### Pause journey and associated activations schedules. - [PATCH /entities/journeys/{journeyId}/pause](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1pause/patch.md): Pause journey and associated activations schedules. ### Resume journey and associated activations schedules. - [PATCH /entities/journeys/{journeyId}/resume](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1resume/patch.md): Resume journey and associated activations schedules. ### Retrieve list of profiles in the journey stage - [GET /entities/journeys/{journeyId}/journey_stages/{journeyStageId}/customers](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journeys~1%7Bjourneyid%7D~1journey_stages~1%7Bjourneystageid%7D~1customers/get.md): Retrieve a list of profiles in a journey stage. ### Return the journey bundle information - [GET /entities/journey_bundles/{journeyBundleId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D/get.md): Return the journey bundle information which contains the list of journey versions ### Update the metadata of the journey bundle - [PATCH /entities/journey_bundles/{journeyBundleId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D/patch.md): Update the editable journey bundle information. The following fields are editable with this API. - name - description - latestJourneyId To update the latest journey, the following validation checks the validity of the operation. - The journey must exist and belong to this journey bundle - The journey must be launched The case when launching new journey as the latest is treated by the POST journey endpoint with the journeyBundleId. ### Delete the journey bundle - [DELETE /entities/journey_bundles/{journeyBundleId}](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D/delete.md): Delete the journey bundle ### Returns the latest journey in the bundle - [GET /entities/journey_bundles/{journeyBundleId}/latest](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1latest/get.md): Returns the latest journey in the bundle ### Return the list of statistics of jouney under the bundle - [GET /entities/journey_bundles/{journeyBundleId}/statistics](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1statistics/get.md): Return the statistics under the journey bundle. ### Return the list of conversion sankey charts of journey under the bundle - [GET /entities/journey_bundles/{journeyBundleId}/conversion_sankey_charts](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1conversion_sankey_charts/get.md): Return the list of conversion sankey charts of journey under the bundle ### Return the list of activation sankey charts of journey under the bundle - [GET /entities/journey_bundles/{journeyBundleId}/activation_sankey_charts](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1activation_sankey_charts/get.md): Return the list of activation sankey charts of journey under the bundle ### Returns the list of activations associated with the journey bundle - [GET /entities/journey_bundles/{journeyBundleId}/activations](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1activations/get.md): Returns the list of activations associated with the journey bundle ### Create the new journey under the bundle with copying the latest journey - [POST /entities/journey_bundles/{journeyBundleId}/journeys](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1journeys/post.md): Return the journey bundle information which contains the list of journey versions ### Validate the journey can be appended to the bundle - [GET /entities/journey_bundles/{journeyBundleId}/journeys_appendable](https://td-public.redocly.app/apis/td_cdp_api-public/journeys/paths/~1entities~1journey_bundles~1%7Bjourneybundleid%7D~1journeys_appendable/get.md): Validate the journey can be appended to the bundle ## Activation Templates Marketers find creating an activation challenging because they have to enter technical information they might not understand, which can lead to activations failing due to misconfigurations. Treasure Data solves this problem with the Activation Template. The Activation Template allows data engineers to create templates with pre-populated fields so that the marketer can confidently create an activation. ### Create an Activation Template - [POST /entities/activation_templates](https://td-public.redocly.app/apis/td_cdp_api-public/activation-templates/activation_templates_create.md) ### Get an Activation Template - [GET /entities/activation_templates/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activation-templates/activation_templates_show.md) ### Update an Activation Template - [PATCH /entities/activation_templates/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activation-templates/activation_templates_update.md) ### Delete an Activation Template - [DELETE /entities/activation_templates/{id}](https://td-public.redocly.app/apis/td_cdp_api-public/activation-templates/activation_templates_delete.md) ### Returns list of Activation Templates by an audience (parent segment) - [GET /entities/parent_segments/{parentSegmentId}/activation_templates](https://td-public.redocly.app/apis/td_cdp_api-public/activation-templates/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1activation_templates/get.md) ## Realtime Journeys ### Get realtime setting for the Audience - [GET /audiences/{audienceId}/realtime_setting](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_setting/get.md): Get realtime setting for the Audience ### Update realtime setting for the Audience - [PATCH /audiences/{audienceId}/realtime_setting](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_setting/patch.md): Update realtime setting for the Audience ### Return a list of Realtime Attributes for the Audience - [GET /audiences/{audienceId}/realtime_attributes](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_attributes/get.md): Return a list of Realtime Attributes for the Audience ### Create a Realtime Attribute - [POST /audiences/{audienceId}/realtime_attributes](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_attributes/post.md): Create a Realtime Attribute ### Return the Realtime Attribute - [GET /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_attributes~1%7Brealtimeattributeid%7D/get.md): Return the Realtime Attribute ### Update the Realtime Attribute - [PATCH /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_attributes~1%7Brealtimeattributeid%7D/patch.md): Update the Realtime Attribute ### Delete the Realtime Attribute - [DELETE /audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_attributes~1%7Brealtimeattributeid%7D/delete.md): Delete the Realtime Attribute ### Bulk update imported attributes - [POST /audiences/{audienceId}/realtime_imported_attributes/bulk_update](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_imported_attributes~1bulk_update/post.md): Bulk update imported attributes ### Return a list of Realtime Key Events for the Audience - [GET /audiences/{audienceId}/realtime_key_events](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events/get.md): Return a list of Realtime Key Events for the Audience ### Create a Realtime Key Event for the Audience - [POST /audiences/{audienceId}/realtime_key_events](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events/post.md): Create a Realtime Key Event for the Audience ### Return the specified Realtime Key Event - [GET /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events~1%7Brealtimekeyeventid%7D/get.md): Return the specified Realtime Key Event ### Edit the specified Realtime Key Event - [PATCH /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events~1%7Brealtimekeyeventid%7D/patch.md): Edit the specified Realtime Key Event ### Delete the specified Realtime Key Event - [DELETE /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events~1%7Brealtimekeyeventid%7D/delete.md): Delete the specified Realtime Key Event ### Return a list of columns of the specified Realtime Key Event - [GET /audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}/columns](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_key_events~1%7Brealtimekeyeventid%7D~1columns/get.md): Return a list of columns of the specified Realtime Key Event ### Return the current version for the Audience - [GET /audiences/{audienceId}/realtime_configuration_versions/current](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1audiences~1%7Baudienceid%7D~1realtime_configuration_versions~1current/get.md): Return the current version for the Audience ### List available realtime attributes - [GET /entities/parent_segments/{parentSegmentId}/realtime_attributes](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1realtime_attributes/get.md): List available realtime attributes ### Create a realtime journey - [POST /entities/realtime_journeys](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys/post.md): Create a realtime journey. ### Retrieve summary of specified realtime journey - [GET /entities/realtime_journeys/{realtimeJourneyId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D/get.md): Retrieve the summary of a specified realtime journey. ### Update realtime journey entity - [PATCH /entities/realtime_journeys/{realtimeJourneyId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D/patch.md): Update a realtime journey entity. ### Delete realtime journey entity - [DELETE /entities/realtime_journeys/{realtimeJourneyId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D/delete.md): Delete a realtime journey entity. ### Validate fields of the realtime journey - [POST /entities/realtime_journeys/{realtimeJourneyId}/detail](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1detail/post.md): Validate fields of the realtime journey ### Retrieve a list of realtime journeys under the Parent Segment - [GET /entities/parent_segments/{parentSegmentId}/realtime_journeys](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1realtime_journeys/get.md): Retrieve a list of realtime journeys under the Parent Segment ### Retrieve a list of realtime activations under the Parent Segment - [GET /entities/parent_segments/{parentSegmentId}/realtime_activations](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1realtime_activations/get.md): Retrieve a list of realtime activations under the Parent Segment ### Retrieve a list of realtime journey activations for the specified realtime journey. - [GET /entities/realtime_journeys/{realtimeJourneyId}/activations](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1activations/get.md): Retrieve a list of realtime journey activations for the specified realtime journey. ### Create a realtime journey activations for the specified realtime journey. - [POST /entities/realtime_journeys/{realtimeJourneyId}/activations](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1activations/post.md): Create a realtime journey activations for the specified realtime journey. ### Retrieve a summary of the activation node in a realtime journey. - [GET /entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1activations~1%7Brealtimejourneyactivationstepid%7D/get.md): Retrieve a summary of the activation node in a realtime journey. ### Update activation node in journey - [PATCH /entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1activations~1%7Brealtimejourneyactivationstepid%7D/patch.md): Update the activation node in a journey. ### Pause activations in the realtime journey. - [PATCH /entities/realtime_journeys/{realtimeJourneyId}/pause](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1pause/patch.md): Pause activations in the realtime journey. ### Resume activations in the realtime journey. - [PATCH /entities/realtime_journeys/{realtimeJourneyId}/resume](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1%7Brealtimejourneyid%7D~1resume/patch.md): Resume activations in the realtime journey. ### Create a duplicate of the specified realtime journey - [POST /entities/realtime_journeys/duplicate](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-journeys/paths/~1entities~1realtime_journeys~1duplicate/post.md): Create a duplicate of the specified realtime journey ## Realtime Personalization ### Return a list of Realtime Personalization Services for the Audience - [GET /audiences/{audienceId}/realtime_personalization_services](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services/get.md): Return a list of Realtime Personalization Services for the Audience ### Create a Realtime Personalization Service for the Audience - [POST /audiences/{audienceId}/realtime_personalization_services](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services/post.md): Create a Realtime Personalization Service for the Audience ### Return the specified Realtime Personalization Service - [GET /audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services~1%7Brealtimepersonalizationserviceid%7D/get.md): Return the specified Realtime Personalization Service ### Edit the specified Realtime Personalization Service - [PATCH /audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services~1%7Brealtimepersonalizationserviceid%7D/patch.md): Edit the specified Realtime Personalization Service ### Delete the specified Realtime Personalization Service - [DELETE /audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services~1%7Brealtimepersonalizationserviceid%7D/delete.md): Delete the specified Realtime Personalization Service ### Create a new Personalization Token - [POST /audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}/tokens](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services~1%7Brealtimepersonalizationserviceid%7D~1tokens/post.md): Create a new Personalization Token ### Delete the specified Realtime Personalization Token - [DELETE /audiences/{audienceId}/realtime_personalization_services/{realtimePersonalizationServiceId}/tokens/{tokenId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1audiences~1%7Baudienceid%7D~1realtime_personalization_services~1%7Brealtimepersonalizationserviceid%7D~1tokens~1%7Btokenid%7D/delete.md): Delete the specified Realtime Personalization Token ### Create a realtime personalization - [POST /entities/realtime_personalizations](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1entities~1realtime_personalizations/post.md): Create a realtime personalization. ### Get a realtime personalization - [GET /entities/realtime_personalizations/{realtimePersonalizationId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1entities~1realtime_personalizations~1%7Brealtimepersonalizationid%7D/get.md): Get a realtime personalization. ### Update a realtime personalization - [PATCH /entities/realtime_personalizations/{realtimePersonalizationId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1entities~1realtime_personalizations~1%7Brealtimepersonalizationid%7D/patch.md): Update a realtime personalization. ### Delete realtime personalization entity - [DELETE /entities/realtime_personalizations/{realtimePersonalizationId}](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1entities~1realtime_personalizations~1%7Brealtimepersonalizationid%7D/delete.md): Delete a realtime personalization entity. ### Retrieve a list of realtime personalizations under the Parent Segment - [GET /entities/parent_segments/{parentSegmentId}/realtime_personalizations](https://td-public.redocly.app/apis/td_cdp_api-public/realtime-personalization/paths/~1entities~1parent_segments~1%7Bparentsegmentid%7D~1realtime_personalizations/get.md): Retrieve a list of realtime personalizations under the Parent Segment