Retrieve list of activations in audience

Request

Retrieve a list of activations (formerly syndications) associated with a parent segment ID and view their status and/or schedules.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Master Segment ID of the syndication

Query

without_detailboolean

If true, the response does not include the detail of the syndication, such as valid, and executions.

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/syndications?without_detail=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json

Array [

idstring, (integer)

audienceIdstring, (integer)

segmentIdstring, (integer)

namestring

descriptionstring

allColumnsboolean

syndication all column flag ('true' means that you use all attribute data)

columnsArray of Columns (objects) or (NullValue (object or null))

One of:

Syndication column detail. Basic syntax is {"column": "alias_name", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without function property.

scheduleTypestring(ScheduleType)

Enum:"cron""daily""hourly""minutes_interval""monthly""none""weekly"

Example:"daily"

scheduleOptionstring or null

startAtstring or null, (^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$)(StartAt)

cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected.

endOnstring or null, (date)

repeatUnitstring or null

repeatFrequencyinteger or null

repeatSubFrequencyArray of integers, (int64)(RepeatSubFrequency)

Parameter for more detailed frequency settings. Values are array of integers. Currently, this parameter is only valid for repeat unit "week". For multiple days of the week, each value should be 1 to 7. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday

Default:[]

Example:

[
  1,
  5,
  6
]

timezonestring

connectionIdstring or null, (integer)

connectorConfigobject or null

createdAtstring, (date-time)

updatedAtstring, (date-time)

createdByobject(User)

updatedByobject(User)

validboolean

executionsArray of objects(SyndicationExecution)

notifyOnArray of strings

Items Enum:"onSuccess""onFailure"

emailRecipientsArray of integers

activationTemplateIdstring or null[1-9][0-9]*

]

Response

[
  {
    "id": "string",
    "audienceId": "string",
    "segmentId": "string",
    "name": "string",
    "description": "string",
    "allColumns": true,
    "columns": [ … ],
    "scheduleType": "daily",
    "scheduleOption": "string",
    "startAt": "string",
    "endOn": "2019-08-24",
    "repeatUnit": "string",
    "repeatFrequency": 0,
    "repeatSubFrequency": [ … ],
    "timezone": "string",
    "connectionId": "string",
    "connectorConfig": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "createdBy": { … },
    "updatedBy": { … },
    "valid": true,
    "executions": [ … ],
    "notifyOn": [ … ],
    "emailRecipients": [ … ],
    "activationTemplateId": "string"
  }
]