List the logged custom parameter and cookie names

The names the raw-log writers keep or drop, by kind: CUSTOM_PARAMETER, the custom parameters carried by an ad request, and COOKIE_NAME, the cookies read from the visitor.

Reference

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

The names the raw-log writers keep or drop, by kind: CUSTOM_PARAMETER, the custom parameters carried by an ad request, and COOKIE_NAME, the cookies read from the visitor. Without 'type' both kinds are answered. 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. Reading needs only an authenticated account.

Query Params

type string

CUSTOM_PARAMETER or COOKIE_NAME; omitted answers both

CUSTOM_PARAMETER

Responses

200

{success, filters: [{type, mode, total, names: [name]}]}

400

'type' names no filter kind

401

Authentication error

403

Forbidden — insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters.do?type=CUSTOM_PARAMETER' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters.do?type=CUSTOM_PARAMETER', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

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.do?type=CUSTOM_PARAMETER"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .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("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters.do?type=CUSTOM_PARAMETER");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/analytics-configuration/request-filters.do?type=CUSTOM_PARAMETER", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	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.do?type=CUSTOM_PARAMETER");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

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.do?type=CUSTOM_PARAMETER")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

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