/

Browse the help center

Set up placement daisy chaining

Switches daisy chaining (the ad waterfall) on or off for a placement and sets its options, as the console's Daisy Chaining card does.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/placements/{placementId}/chaining.do

Switches daisy chaining (the ad waterfall) on or off for a placement and sets its options, as the console's Daisy Chaining card does. enabled=true (or a type) switches it on; type chooses whether the chain orders BANNERs or CAMPAIGNs; enabled=false switches it off and drops the chain. lookupDepth, viewPerEntityEnabled/viewPerEntityCount, rotatingEnabled/rotatingCount and groupByDeliveryPriority set the chain's options; only the ones sent change. The options need daisy chaining on - in the same request or before. Needs the Daisy Chaining permission and update rights on the placement's site.

Path Params

placementId integer required

Placement id

4001

Form Params

enabled boolean

true switches daisy chaining on, false switches it off and drops the chain

true

groupByDeliveryPriority boolean

Order the chain within each delivery priority

false

lookupDepth integer

How many entries of the chain are tried for one ad request, 1 to 100

5

rotatingCount integer

Rotation count when rotatingEnabled, 1 to 10000000

2

rotatingEnabled boolean

Rotate the chain's entries

false

type string

What the chain orders: BANNER or CAMPAIGN; switches daisy chaining on

CAMPAIGN

viewPerEntityCount integer

Views per entry when viewPerEntityEnabled, 1 to 10000000

3

viewPerEntityEnabled boolean

Cap how many times each entry is shown before the next one

true

Responses

200

{placementId, enabled, type, lookupDepth, viewPerEntityEnabled, viewPerEntityCount, rotatingEnabled, rotatingCount, groupByDeliveryPriority}

400

Nothing sent, an option for a placement whose daisy chaining is off, enabled=false together with a type or an option, or a depth or count below 1

401

Authentication error

403

The Daisy Chaining permission is off, or no update rights on the placement's site

404

The placement does not exist or is deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'type=CAMPAIGN' \
  --data-urlencode 'enabled=true' \
  --data-urlencode 'groupByDeliveryPriority=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"type": "CAMPAIGN", "enabled": "true", "groupByDeliveryPriority": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"type":"CAMPAIGN","enabled":"true","groupByDeliveryPriority":"false"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("type=CAMPAIGN&enabled=true&groupByDeliveryPriority=false"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["type"] = "CAMPAIGN", ["enabled"] = "true", ["groupByDeliveryPriority"] = "false" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do", strings.NewReader(`type=CAMPAIGN&enabled=true&groupByDeliveryPriority=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'type=CAMPAIGN&enabled=true&groupByDeliveryPriority=false');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/placements/4001/chaining.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('type' => "CAMPAIGN", 'enabled' => "true", 'groupByDeliveryPriority' => "false")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body