Skip to content

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

scheduleTypestring(ScheduleType)
Enum:"cron""daily""hourly""minutes_interval""monthly""none""weekly"
Example:"daily"
scheduleOptionstring or null
defaultTimeFilterEnabledboolean
]
Response
[ { "id": "string", "name": "string", "parentDatabaseName": "string", "parentTableName": "string", "parentKey": "string", "foreignKey": "string", "schema": [], "scheduleType": "daily", "scheduleOption": "string", "defaultTimeFilterEnabled": true } ]