latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Parent Segment Configurations

Retrieve list of parent segment configurations

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.

get/audiences

Response

successful operation

idstring integer

namestring required

descriptionstring

scheduleOptionstring nullable

timezonestring

matrixUpdatedAtstring datetime nullable

workflowHiveOnlyboolean

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

hiveEngineVersion'0.13' | 'cdpaudience'

Hive engine version used in audience workflows

hivePoolNamestring nullable

prestoPoolNamestring nullable

allowActivationBehaviorboolean nullable

maxActivationBehaviorRowinteger nullable

Only null is acceptable when allowActivationBehavior is false.

llmEnabledboolean nullable

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

llmState'enabling' | 'enabled' | 'disabling' | 'disabled'

llmState indicates more detailed state including updating.

populationinteger nullable

the population of the audience

enrichmentWordTaggingEnabledboolean

enrichmentIpEnabledboolean

enrichmentTdJsSdkEnabledboolean

createdAtstring date-time

updatedAtstring date-time

Example response

[
  {
    "scheduleType": "daily",
    "scheduleOption": "00:00",
    "timezone": "UTC",
    "behaviors": [
      {
        "scheduleType": "daily"
      }
    ],
    "audienceFilters": [
      {
        "columnName": "Country",
        "rightValues": [
          "Japan"
        ]
      }
    ]
  }
]