Skip to content
Audience API
/
Parent Segment Configurations
/
Update parent segment configuration

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
audience_api_v1.json
audience_api_v1.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

Retrieve list of parent segment configurations

Request

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.

Security
TdApikeyAuth
curl -i -X GET \
  https://api-cdp.treasuredata.com/audiences \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
idstring(integer)
namestringrequired
descriptionstring
scheduleTypestring(ScheduleType)
Enum"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example: "daily"
scheduleOptionstring or null
Example: "00:00"
timezonestring
Example: "UTC"
matrixUpdatedAtstring or null(datetime)
workflowHiveOnlyboolean

Whether the workflow mainly use Hive or not. Default is false

hiveEngineVersionstring

Hive engine version used in audience workflows

Enum"0.13""cdpaudience"
hivePoolNamestring or null
prestoPoolNamestring or null
allowActivationBehaviorboolean or null
maxActivationBehaviorRowinteger or null

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean or null

llmEnabled indicates whether customer has enabled llm (true or false).

llmStatestring

llmState indicates more detailed state including updating.

Enum"enabling""enabled""disabling""disabled"
populationinteger or null(int64)

the population of the audience

enrichmentWordTaggingEnabledboolean
enrichmentIpEnabledboolean
enrichmentTdJsSdkEnabledboolean
masterobject(AudienceMaster)
attributesArray of objects(AudienceAttribute)
behaviorsArray of objects(AudienceBehavior)
customerGroupobject(CustomerGroup)

A group of customers within an audience

audienceFiltersArray of objects(AudienceFilter)<= 2 items
createdAtstring(date-time)
updatedAtstring(date-time)
createdByobject(User)
updatedByobject(User)
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "scheduleType": "daily",
    "scheduleOption": "00:00",
    "timezone": "UTC",
    "matrixUpdatedAt": "string",
    "workflowHiveOnly": true,
    "hiveEngineVersion": "0.13",
    "hivePoolName": "string",
    "prestoPoolName": "string",
    "allowActivationBehavior": true,
    "maxActivationBehaviorRow": 0,
    "llmEnabled": true,
    "llmState": "enabling",
    "population": 0,
    "enrichmentWordTaggingEnabled": true,
    "enrichmentIpEnabled": true,
    "enrichmentTdJsSdkEnabled": true,
    "master": { … },
    "attributes": [ … ],
    "behaviors": [ … ],
    "customerGroup": { … },
    "audienceFilters": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdBy": { … },
    "updatedBy": { … }
  }
]

Create new parent segment configuration

Request

Create a new parent segment configuration.

Security
TdApikeyAuth
Bodyapplication/jsonrequired

Create a new Master Segment Config

idstring(integer)
namestringrequired
descriptionstring
scheduleTypestring(ScheduleType)
Enum"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example: "daily"
scheduleOptionstring or null
Example: "00:00"
timezonestring
Example: "UTC"
matrixUpdatedAtstring or null(datetime)
workflowHiveOnlyboolean

Whether the workflow mainly use Hive or not. Default is false

hiveEngineVersionstring

Hive engine version used in audience workflows

Enum"0.13""cdpaudience"
hivePoolNamestring or null
prestoPoolNamestring or null
allowActivationBehaviorboolean or null
maxActivationBehaviorRowinteger or null

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean or null

llmEnabled indicates whether customer has enabled llm (true or false).

llmStatestring

llmState indicates more detailed state including updating.

Enum"enabling""enabled""disabling""disabled"
populationinteger or null(int64)

the population of the audience

enrichmentWordTaggingEnabledboolean
enrichmentIpEnabledboolean
enrichmentTdJsSdkEnabledboolean
masterobject(AudienceMaster)
attributesArray of objects(AudienceAttribute)
behaviorsArray of objects(AudienceBehavior)
customerGroupobject(CustomerGroup)

A group of customers within an audience

audienceFiltersArray of objects(AudienceFilter)<= 2 items
createdAtstring(date-time)
updatedAtstring(date-time)
createdByobject(User)
updatedByobject(User)
curl -i -X POST \
  https://api-cdp.treasuredata.com/audiences \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "scheduleType": "daily",
    "scheduleOption": "00:00",
    "timezone": "UTC",
    "matrixUpdatedAt": "string",
    "workflowHiveOnly": true,
    "hiveEngineVersion": "0.13",
    "hivePoolName": "string",
    "prestoPoolName": "string",
    "allowActivationBehavior": true,
    "maxActivationBehaviorRow": 0,
    "llmEnabled": true,
    "llmState": "enabling",
    "population": 0,
    "enrichmentWordTaggingEnabled": true,
    "enrichmentIpEnabled": true,
    "enrichmentTdJsSdkEnabled": true,
    "master": {
      "parentDatabaseName": "string",
      "parentTableName": "string"
    },
    "attributes": [
      {
        "audienceId": "string",
        "name": "string",
        "type": "string",
        "parentDatabaseName": "string",
        "parentTableName": "string",
        "parentColumn": "string",
        "parentKey": "string",
        "foreignKey": "string",
        "groupingName": "string"
      }
    ],
    "behaviors": [
      {
        "id": "string",
        "name": "string",
        "parentDatabaseName": "string",
        "parentTableName": "string",
        "parentKey": "string",
        "foreignKey": "string",
        "schema": [
          {
            "name": "string",
            "type": "string",
            "parentColumn": "string"
          }
        ],
        "scheduleType": "daily",
        "scheduleOption": "string",
        "defaultTimeFilterEnabled": true,
        "isRealtime": true
      }
    ],
    "customerGroup": {
      "id": "string",
      "audienceId": 0,
      "name": "string",
      "parentDatabaseName": "string",
      "parentTableName": "string",
      "parentKey": "string",
      "foreignKey": "string",
      "customerGroupAttributes": [
        {
          "name": "string",
          "type": "string",
          "parentDatabaseName": "string",
          "parentTableName": "string",
          "parentColumn": "string",
          "parentKey": "string",
          "foreignKey": "string"
        }
      ],
      "customerGroupBehaviors": [
        {
          "name": "string",
          "parentDatabaseName": "string",
          "parentTableName": "string",
          "parentKey": "string",
          "foreignKey": "string",
          "schema": [
            {
              "name": "string",
              "type": "string",
              "parentColumn": "string"
            }
          ]
        }
      ]
    },
    "audienceFilters": [
      {
        "columnName": "Country",
        "rightValues": [
          "Japan"
        ]
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string",
      "td_user_id": "string",
      "name": "string"
    },
    "updatedBy": {
      "id": "string",
      "td_user_id": "string",
      "name": "string"
    }
  }'

Responses

Given parameters are not valid

Bodyapplication/json
codestringrequired
messagestringrequired
Response
application/json
{
  "code": "string",
  "message": "string"
}

Retrieve parent segment configuration by ID

Request

Search and find a specified parent segment configuration by its identifier.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config to return

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

Responses

successful operation

Bodyapplication/json
idstring(integer)
namestringrequired
descriptionstring
scheduleTypestring(ScheduleType)
Enum"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example: "daily"
scheduleOptionstring or null
Example: "00:00"
timezonestring
Example: "UTC"
matrixUpdatedAtstring or null(datetime)
workflowHiveOnlyboolean

Whether the workflow mainly use Hive or not. Default is false

hiveEngineVersionstring

Hive engine version used in audience workflows

Enum"0.13""cdpaudience"
hivePoolNamestring or null
prestoPoolNamestring or null
allowActivationBehaviorboolean or null
maxActivationBehaviorRowinteger or null

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean or null

llmEnabled indicates whether customer has enabled llm (true or false).

llmStatestring

llmState indicates more detailed state including updating.

Enum"enabling""enabled""disabling""disabled"
populationinteger or null(int64)

the population of the audience

enrichmentWordTaggingEnabledboolean
enrichmentIpEnabledboolean
enrichmentTdJsSdkEnabledboolean
masterobject(AudienceMaster)
attributesArray of objects(AudienceAttribute)
behaviorsArray of objects(AudienceBehavior)
customerGroupobject(CustomerGroup)

A group of customers within an audience

audienceFiltersArray of objects(AudienceFilter)<= 2 items
createdAtstring(date-time)
updatedAtstring(date-time)
createdByobject(User)
updatedByobject(User)
Response
application/json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "scheduleType": "daily",
  "scheduleOption": "00:00",
  "timezone": "UTC",
  "matrixUpdatedAt": "string",
  "workflowHiveOnly": true,
  "hiveEngineVersion": "0.13",
  "hivePoolName": "string",
  "prestoPoolName": "string",
  "allowActivationBehavior": true,
  "maxActivationBehaviorRow": 0,
  "llmEnabled": true,
  "llmState": "enabling",
  "population": 0,
  "enrichmentWordTaggingEnabled": true,
  "enrichmentIpEnabled": true,
  "enrichmentTdJsSdkEnabled": true,
  "master": {
    "parentDatabaseName": "string",
    "parentTableName": "string"
  },
  "attributes": [
    { … }
  ],
  "behaviors": [
    { … }
  ],
  "customerGroup": {
    "id": "string",
    "audienceId": 0,
    "name": "string",
    "parentDatabaseName": "string",
    "parentTableName": "string",
    "parentKey": "string",
    "foreignKey": "string",
    "customerGroupAttributes": [ … ],
    "customerGroupBehaviors": [ … ]
  },
  "audienceFilters": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "td_user_id": "string",
    "name": "string"
  },
  "updatedBy": {
    "id": "string",
    "td_user_id": "string",
    "name": "string"
  }
}

Update parent segment configuration

Request

Update the specified parent segment configuration by its identifier.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config that needs to be updated

Bodyapplication/json
idstring(integer)
namestringrequired
descriptionstring
scheduleTypestring(ScheduleType)
Enum"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example: "daily"
scheduleOptionstring or null
Example: "00:00"
timezonestring
Example: "UTC"
matrixUpdatedAtstring or null(datetime)
workflowHiveOnlyboolean

Whether the workflow mainly use Hive or not. Default is false

hiveEngineVersionstring

Hive engine version used in audience workflows

Enum"0.13""cdpaudience"
hivePoolNamestring or null
prestoPoolNamestring or null
allowActivationBehaviorboolean or null
maxActivationBehaviorRowinteger or null

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean or null

llmEnabled indicates whether customer has enabled llm (true or false).

llmStatestring

llmState indicates more detailed state including updating.

Enum"enabling""enabled""disabling""disabled"
populationinteger or null(int64)

the population of the audience

enrichmentWordTaggingEnabledboolean
enrichmentIpEnabledboolean
enrichmentTdJsSdkEnabledboolean
masterobject(AudienceMaster)
attributesArray of objects(AudienceAttribute)
behaviorsArray of objects(AudienceBehavior)
customerGroupobject(CustomerGroup)

A group of customers within an audience

audienceFiltersArray of objects(AudienceFilter)<= 2 items
createdAtstring(date-time)
updatedAtstring(date-time)
createdByobject(User)
updatedByobject(User)
curl -i -X PUT \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "scheduleType": "daily",
    "scheduleOption": "00:00",
    "timezone": "UTC",
    "matrixUpdatedAt": "string",
    "workflowHiveOnly": true,
    "hiveEngineVersion": "0.13",
    "hivePoolName": "string",
    "prestoPoolName": "string",
    "allowActivationBehavior": true,
    "maxActivationBehaviorRow": 0,
    "llmEnabled": true,
    "llmState": "enabling",
    "population": 0,
    "enrichmentWordTaggingEnabled": true,
    "enrichmentIpEnabled": true,
    "enrichmentTdJsSdkEnabled": true,
    "master": {
      "parentDatabaseName": "string",
      "parentTableName": "string"
    },
    "attributes": [
      {
        "audienceId": "string",
        "name": "string",
        "type": "string",
        "parentDatabaseName": "string",
        "parentTableName": "string",
        "parentColumn": "string",
        "parentKey": "string",
        "foreignKey": "string",
        "groupingName": "string"
      }
    ],
    "behaviors": [
      {
        "id": "string",
        "name": "string",
        "parentDatabaseName": "string",
        "parentTableName": "string",
        "parentKey": "string",
        "foreignKey": "string",
        "schema": [
          {
            "name": "string",
            "type": "string",
            "parentColumn": "string"
          }
        ],
        "scheduleType": "daily",
        "scheduleOption": "string",
        "defaultTimeFilterEnabled": true,
        "isRealtime": true
      }
    ],
    "customerGroup": {
      "id": "string",
      "audienceId": 0,
      "name": "string",
      "parentDatabaseName": "string",
      "parentTableName": "string",
      "parentKey": "string",
      "foreignKey": "string",
      "customerGroupAttributes": [
        {
          "name": "string",
          "type": "string",
          "parentDatabaseName": "string",
          "parentTableName": "string",
          "parentColumn": "string",
          "parentKey": "string",
          "foreignKey": "string"
        }
      ],
      "customerGroupBehaviors": [
        {
          "name": "string",
          "parentDatabaseName": "string",
          "parentTableName": "string",
          "parentKey": "string",
          "foreignKey": "string",
          "schema": [
            {
              "name": "string",
              "type": "string",
              "parentColumn": "string"
            }
          ]
        }
      ]
    },
    "audienceFilters": [
      {
        "columnName": "Country",
        "rightValues": [
          "Japan"
        ]
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": "string",
      "td_user_id": "string",
      "name": "string"
    },
    "updatedBy": {
      "id": "string",
      "td_user_id": "string",
      "name": "string"
    }
  }'

Responses

Given parameters are not valid

Bodyapplication/json
codestringrequired
messagestringrequired
Response
application/json
{
  "code": "string",
  "message": "string"
}

Delete parent segment configuration

Request

Delete a previously created parent segment configuration.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

Master Segment Config id to delete

curl -i -X DELETE \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Master Segment Config not found

Body

Retrieve list of audience attributes

Request

Retrieve a list of parent segment attributes. You can also specify the visibility level for sensitive attributes.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config to return

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/attributes' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
One of:
audienceIdstringrequired

ID of Master Segment for this attribute

idstring or null

This can be null when the attribute is an enriched attribute

namestringrequired

Column name user defined on Master Segment Configuration page of Data Workbench

typestringrequired

Type of the column

parentDatabaseNamestringrequired

Database name of the attribute table

parentTableNamestringrequired

Table name of the attribute table

parentColumnstringrequired

Column name of the attribute table which is imported into customer table

parentKeystring or nullrequired

Join key of the attribute table (This can be null when the attribute is an enriched attribute)

foreignKeystring or nullrequired

Foreign key of the master table (This can be null when the attribute is an enriched attribute)

matrixColumnNamestring
usedBySegmentInsightboolean
groupingNamestring or null

Group name of the attribute

visibilitystring
Enum"clear""pii""non_pii""blocked"
]
Response
application/json
[
  {
    "audienceId": "string",
    "id": "string",
    "name": "string",
    "type": "string",
    "parentDatabaseName": "string",
    "parentTableName": "string",
    "parentColumn": "string",
    "parentKey": "string",
    "foreignKey": "string",
    "matrixColumnName": "string",
    "usedBySegmentInsight": true,
    "groupingName": "string",
    "visibility": "clear"
  }
]

Retrieve list of audience behaviors

Request

Retrieve a list of parent segment behaviors.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config to return

Query
realtimeboolean
curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/behaviors?realtime=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
idstringrequired

ID of Master Segment Config behavior

namestringrequired

Behavior name user defined on Master Segment Configuration page of Data Workbench

parentDatabaseNamestringrequired

Database name of the behavior table

parentTableNamestringrequired

Table name of the behavior table

parentKeystringrequired

Join key of the behavior table

foreignKeystringrequired

Foreign key of the master table

schemaArray of objects(AudienceBehaviorSchemaWithVisibility)required

Columns of behavior

schema[].​namestringrequired

Column name user defined on Master Segment Configuration page of Data Workbench

schema[].​typestringrequired

Type of the column

schema[].​parentColumnstring or nullrequired

Column name of the behavior table (This can be null when the column is an enriched column)

schema[].​matrixColumnNamestring

Column name of the behavior table

schema[].​visibilitystring
Enum"clear""pii""non_pii""blocked"
scheduleTypestring(ScheduleType)
Enum"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example: "daily"
scheduleOptionstring or null
defaultTimeFilterEnabledboolean
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "parentDatabaseName": "string",
    "parentTableName": "string",
    "parentKey": "string",
    "foreignKey": "string",
    "schema": [ … ],
    "scheduleType": "daily",
    "scheduleOption": "string",
    "defaultTimeFilterEnabled": true
  }
]

Run workflow to (re)generate parent segment

Request

Run the workflow to generate or regenerate a parent segment.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

Master Segment Config id to delete

curl -i -X POST \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/run' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Succeeded to run the workflow

Bodyapplication/json
workflowIdstring[1-9][0-9]*|0required
workflowSessionIdstring[1-9][0-9]*required
createdAtstring(date-time)required
finishedAtstring or null(date-time)required
statusstringrequired
Enum"success""canceled""error""canceling""running"
workflowAttemptIdstring[1-9][0-9]*required
audienceIdstring(integer)
Response
application/json
{
  "workflowId": "string",
  "workflowSessionId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "finishedAt": "2019-08-24T14:15:22Z",
  "status": "success",
  "workflowAttemptId": "string",
  "audienceId": "string"
}

Retrieve list of executions using audienceId

Request

Retrieve a list of workflow executions, whether they were succesful or not, and their status.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

Master Segment Config id to delete

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/executions' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Succeeded to run the workflow

Bodyapplication/jsonArray [
workflowIdstring[1-9][0-9]*|0required
workflowSessionIdstring[1-9][0-9]*required
createdAtstring(date-time)required
finishedAtstring or null(date-time)required
statusstringrequired
Enum"success""canceled""error""canceling""running"
workflowAttemptIdstring[1-9][0-9]*required
audienceIdstring(integer)
]
Response
application/json
[
  {
    "workflowId": "string",
    "workflowSessionId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "status": "success",
    "workflowAttemptId": "string",
    "audienceId": "string"
  }
]

Retrieve population statistics audience

Request

Retrieve the population history of the audience. The history is returned per day and those days are calculated in the timezone of the audience.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

Master Segment Config id to delete

Example: 1234
Query
fromstring(date)

from date

Example: from=2019-01-01
tostring(date)

to date (inclusive)

Example: to=2019-04-30
curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/1234/statistics?from=2019-01-01&to=2019-04-30' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

array of tuple of statistics

Bodyapplication/jsonArray [Array [
One of:
integer(int64)
]]
Response
application/json
[
  [
    1556382847,
    1234,
    true
  ]
]

Retrieve list of values for a parent segment configuration's attribute

Request

Retrieve a list of sample values associated with the attributes of a parent segment configuration.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config to return

Query
columnstringrequired
limitnumber>= 1
samplesnumber>= 1
curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/sample_values?column=string&limit=1&samples=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [Array [
Any of:
integer
]]
Response
application/json
[
  [
    "Japan",
    0.14285714285714285
  ]
]

Retrieve list of sample values for a parent segment configuration's behavior

Request

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.

Security
TdApikeyAuth
Path
audienceIdinteger(int64)required

ID of Master Segment Config to operate on

audienceBehaviorIdinteger(int64)required

ID of Master Segment Config behavior to operate on

Query
columnstringrequired
limitnumber>= 1
samplesnumber>= 1
curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/behaviors/{audienceBehaviorId}/sample_values?column=string&limit=1&samples=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [Array [
Any of:
integer
]]
Response
application/json
[
  [
    "Japan",
    0.14285714285714285
  ]
]

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