Retrieve activation by ID

Request

Retrieve an activation (formerly syndication) based on its identifier.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Master Segment ID of the syndication

segmentIdinteger, (int64)required

Segment ID of the syndication

syndicationIdinteger, (int64)required

ID of Syndication to return

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json

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": [
    1,
    5,
    6
  ],
  "timezone": "string",
  "connectionId": "string",
  "connectorConfig": {},
  "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"
  },
  "valid": true,
  "executions": [
    { … }
  ],
  "notifyOn": [
    "onSuccess"
  ],
  "emailRecipients": [
    0
  ],
  "activationTemplateId": "string"
}