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

Array [

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, <= 2 items(AudienceFilter)

createdAtstring, (date-time)

updatedAtstring, (date-time)

createdByobject(User)

updatedByobject(User)

]

Response

[
  {
    "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": { … }
  }
]