Sign in
latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Activations

Retrieve list of activations in audience

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

get/audiences/{audienceId}/syndications

Path parameters

audienceIdinteger required

Master Segment ID of the syndication

Query parameters

without_detailboolean

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

Response

successful operation

idstring integer
audienceIdstring integer
segmentIdstring integer
namestring
descriptionstring
allColumnsboolean

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

scheduleType'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly'
scheduleOptionstring nullable
startAtstring ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ nullable

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

endOnstring date nullable
repeatUnitstring nullable
repeatFrequencyinteger nullable
repeatSubFrequencyinteger[]

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

timezonestring
connectionIdstring integer nullable
connectorConfigobject nullable
createdAtstring date-time
updatedAtstring date-time
validboolean
notifyOnstring[]
emailRecipientsinteger[]
activationTemplateIdstring nullable

Example response

[
  {
    "columns": [
      {
        "column": "alias_name",
        "source": {
          "column": "real_column_name"
        }
      }
    ],
    "scheduleType": "daily",
    "repeatSubFrequency": [
      1,
      5,
      6
    ]
  }
]