Skip to content
API Documents/
/
/
Create new parent segment...

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, <= 2 items(AudienceFilter)
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
{
  "code": "string",
  "message": "string"
}