Retrieve list of activations recursively under a folder

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

SecurityTdApikeyAuth
Request
path Parameters
audienceId
required
integer <int64>

Master Segment id of the syndications

folderId
required
integer <int64>

Segment Folder ID

query Parameters
sorted_by
string <{sort_key}:{option}>

a sort key with an option

Examples:
sorted_by=connection_type:asc
sorted_by=segment_id:asc
sorted_by=segment_name:desc
sorted_by=activation_template_id:desc
sorted_by=activation_template_name:asc
sorted_by=start_at:desc
sorted_by=repeat_unit:asc
sorted_by=created_by_td_user_id:asc
sorted_by=created_by_user_name:desc
sorted_by=updated_at:desc
sorted_by=created_at:desc
name_include
string

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

segment_name_include
string

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

start_after
string <date-time>

filter by start_at to return only Activations that starts after

start_before
string <date-time>

filter by start_at to return only Activations that starts before

connection_type
Array 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_status
Array of strings

filter by schedule_status

Items Enum: "none" "inactive" "scheduled" "active"
created_by_td_user_id
Array of integers <int64>

filter by the User ID of created_by

Array of integers or strings

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_unit
Array 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

Responses
200

successful operation

400

Given parameters are not valid

401

Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource was not found

4XX

There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

get/audiences/{audienceId}/folders/{folderId}/syndications
Request samples
Response samples
application/json
{
  • "syndications": [
    ],
  • "pagination": {
    }
}