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

Any of:

An audience handles a Master Segment and a related 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)

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