Skip to content
/Realtime Journeys

cdp-api (1.0.0)

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. For historical reasons there are REST API endpoints and JSON:API endpoints. JSON:API endpoints are located under "/entities".

Treasure Data Support Site
Download OpenAPI description
td_cdp_api-public.json
td_cdp_api-public.yaml
Overview

Terms of Service

Languages
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/

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.

Operations

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.

Operations

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.

Operations

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.

Operations

Activations

Activation is the process that allows marketers to personalize communication to users interested in your brand.

  • Funnel activation — Create a funnel activation for each funnel stage. The activation exports to external marketing tools for campaigns or BI tools for analysis and reporting.
  • Segment activation — Activate the segment data (export) to external tools for activities such as marketing campaigns, business analysis, and social media. Targets include Email Marketing Systems, Marketing Automation Systems, Advertising Platforms, CRM, ERP, Cloud Services, and SFTP.

Known formerly as syndication in Audience Studio Legacy. You may continue to see syndication referenced in Treasure Data APIs.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

Realtime Journeys

Operations

Get realtime setting for the Audience

Request

Get realtime setting for the Audience

Path
audienceIdinteger(int64)required

Audience ID

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_setting'

Responses

Returns the realtime setting for the Audience

Bodyapplication/json
idstring[1-9][0-9]*
keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required
keyColumns[].​namestringrequired
keyColumns[].​validRegexpstring or null
keyColumns[].​invalidTextsArray of strings>= 0 characters
keyColumns[].​internalboolean
eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required
eventTables[].​databasestringrequired
eventTables[].​tablestringrequired
batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required
batchAttributes[].​columnstringrequired
batchAttributes[].​namestring or null
extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

statusstringrequired
Enum"initialized""updating""ok""inconsistent""not_initialized"
Response
application/json
{
  "id": "string",
  "keyColumns": [
    { … }
  ],
  "eventTables": [
    { … }
  ],
  "batchAttributes": [
    { … }
  ],
  "extLookupKey": "string",
  "status": "initialized"
}

Update realtime setting for the Audience

Request

Update realtime setting for the Audience

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

Audience ID

Bodyapplication/jsonrequired

parameters to edit the realtime setting

keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required
keyColumns[].​namestringrequired
keyColumns[].​validRegexpstring or null
keyColumns[].​invalidTextsArray of strings>= 0 characters
keyColumns[].​internalboolean
eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required
eventTables[].​databasestringrequired
eventTables[].​tablestringrequired
batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required
batchAttributes[].​columnstringrequired
batchAttributes[].​namestring or null
extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

curl -i -X PATCH \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_setting' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "keyColumns": [
      {
        "name": "string",
        "validRegexp": "string",
        "invalidTexts": [
          "string"
        ],
        "internal": true
      }
    ],
    "eventTables": [
      {
        "database": "string",
        "table": "string"
      }
    ],
    "batchAttributes": [
      {
        "column": "string",
        "name": "string"
      }
    ],
    "extLookupKey": "string"
  }'

Responses

Returns the realtime setting for the Audience

Bodyapplication/json
idstring[1-9][0-9]*
keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required
keyColumns[].​namestringrequired
keyColumns[].​validRegexpstring or null
keyColumns[].​invalidTextsArray of strings>= 0 characters
keyColumns[].​internalboolean
eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required
eventTables[].​databasestringrequired
eventTables[].​tablestringrequired
batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required
batchAttributes[].​columnstringrequired
batchAttributes[].​namestring or null
extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

statusstringrequired
Enum"initialized""updating""ok""inconsistent""not_initialized"
Response
application/json
{
  "id": "string",
  "keyColumns": [
    { … }
  ],
  "eventTables": [
    { … }
  ],
  "batchAttributes": [
    { … }
  ],
  "extLookupKey": "string",
  "status": "initialized"
}

Return a list of Realtime Attributes for the Audience

Request

Return a list of Realtime Attributes for the Audience

Path
audienceIdinteger(int64)required

Audience ID

Query
page[after]string

A string to fetch more page. The next value should be present at the pagination.nextPage in the previous response if more pages exist.

page[size]number[ 1 .. 1000 ]

The maximum number of results to return per page

Default 100
sorted_bystring

Specify the sort order in the format foo:asc or foo:desc.

name_includestring

filter by the resource's name

typesstring

filter by the resource's type

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_attributes?page%5Bafter%5D=string&page%5Bsize%5D=100&sorted_by=string&name_include=string&types=string'

Responses

A list of Realtime Attributes for the Audience

Bodyapplication/json
dataArray of objectsrequired
data[].​namestringrequired
data[].​identifierstringrequired
data[].​typestringrequired
Value"imported"
Discriminator
data[].​descriptionstring or null
data[].​createdByobject(User)
data[].​updatedByobject(User)
data[].​createdAtstring(date-time)
data[].​updatedAtstring(date-time)
paginationobjectrequired
pagination.​nextPagestring or nullrequired

The path part of URL of the next page

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "nextPage": "string"
  }
}

Realtime Personalization

Operations