Add logged custom parameter or cookie names

Adds names to one kind's list - the console's Analytics configuration page, which adds them one at a time.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.do

Adds names to one kind's list - the console's Analytics configuration page, which adds them one at a time. 'names' takes one name or several, comma-separated, each at most 128 characters; blanks are ignored and a name already on the list is reported under 'alreadyPresent' rather than stored twice, so the call can be repeated. Each kind's list is read one of two ways, and the answer says which under 'mode': INCLUDE, the default - only these names are logged - or EXCLUDE, where these are the names left out and everything else is logged. The switch is the *Blacklist* toggle on the console's Analytics configuration page (stored as the analyticsCustomParametersFilteringExclude / analyticsCookieNamesFilteringExclude network preference) and is not changed here, so read it before adding a name: in EXCLUDE mode a name you add stops being logged. While a kind's filtering is switched off in the ad-server configuration the list has no effect at all. The answer is the kind's whole list after the add, so it can be confirmed. Requires the ANALYTICS_CONFIGURATION admin permission (Admin -> Analytics configuration).

Form Params

names array<string> required

The names, comma-separated or repeated; each at most 128 characters, blanks ignored

utm_source

type string required

CUSTOM_PARAMETER or COOKIE_NAME

CUSTOM_PARAMETER

Responses

200

{success, type, mode, added, alreadyPresent, total, names}

400

'names' is empty, names more than 200 at once, or holds one over 128 characters; 'type' names no filter kind

401

Authentication error

403

Without the ANALYTICS_CONFIGURATION admin permission

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'names=utm_source' \
  --data-urlencode 'type=CUSTOM_PARAMETER'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"names": "utm_source", "type": "CUSTOM_PARAMETER"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"names":"utm_source","type":"CUSTOM_PARAMETER"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("names=utm_source&type=CUSTOM_PARAMETER"))
    .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/analytics-configuration/request-filters/add.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["names"] = "utm_source", ["type"] = "CUSTOM_PARAMETER" });

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/analytics-configuration/request-filters/add.do", strings.NewReader(`names=utm_source&type=CUSTOM_PARAMETER`))
	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/analytics-configuration/request-filters/add.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, 'names=utm_source&type=CUSTOM_PARAMETER');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters/add.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('names' => "utm_source", 'type' => "CUSTOM_PARAMETER")

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