Retrieve list of activations recursively under a folder

Request

Retrieve a list of activations (formerly syndications) recursively under a folder.

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Master Segment id of the syndications

folderIdinteger, (int64)required

Segment Folder ID

Query

sorted_bystring, ({sort_key}:{option})

a sort key with an option

Examples:

Sorted by connection_type in an ascending order (Note that Pagination parameters page[size] and page[after] are ignored if sorted by connection_type)

sorted_by=connection_type:asc

Sorted by segment_id in an ascending order

sorted_by=segment_id:asc

Sorted by segment_name in an descending order

sorted_by=segment_name:desc

Sorted by activation_template_id in an descending order

sorted_by=activation_template_id:desc

Sorted by activation_template_name in an ascending order

sorted_by=activation_template_name:asc

Sorted by start_at in an descending order

sorted_by=start_at:desc

Sorted by repeat_unit in an ascending alphabetical order

sorted_by=repeat_unit:asc

Sorted by the User ID of created_by in an ascending order

sorted_by=created_by_td_user_id:asc

Sorted by the User Name of created_by in an descending order

sorted_by=created_by_user_name:desc

Sorted by updated_at in an descending order

sorted_by=updated_at:desc

Sorted by created_at in an descending order

sorted_by=created_at:desc

name_includestring

filter by Activation's name to return only Activations whose name includes the value

segment_name_includestring

filter by Segment's name to return only Activations whose Segment name includes the value

start_afterstring, (date-time)

filter by start_at to return only Activations that starts after

start_beforestring, (date-time)

filter by start_at to return only Activations that starts before

connection_typeArray of strings

filter by Connection Type return only Activations whose Connection Types match (Note that Pagination parameters page[size] and page[after] are ignored if connection_type is specified)

schedule_statusArray of strings

filter by schedule_status

Items Enum:"none""inactive""scheduled""active"

created_by_td_user_idArray of integers, (int64)

filter by the User ID of created_by

activation_template_idArray of any

filter by activation_template_id, "none" matches with an Activation that has no Activation Template, but it does not match with an Activation that has a deleted Activation Template

repeat_unitArray of strings

filter by repeat_unit

Items Enum:"hour""day""week""month""minute""once""none"

page[after]string

An opaque cursor to get the next syndications

page[size]integer, (int64)

The paginated number of syndications to get

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/folders/{folderId}/syndications?sorted_by=connection_type%3Aasc&name_include=string&segment_name_include=string&start_after=2019-08-24T14%3A15%3A22Z&start_before=2019-08-24T14%3A15%3A22Z&connection_type=string&schedule_status=none&created_by_td_user_id=0&activation_template_id=0&repeat_unit=hour&page%5Bafter%5D=string&page%5Bsize%5D=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json

syndicationsArray of objects(SyndicationOverview)

paginationobject

Response

{
  "syndications": [
    { … }
  ],
  "pagination": {
    "hasNext": true,
    "nextPage": "string",
    "approximateCount": 0
  }
}