/

Browse the help center

Create site custom parameter targeting

Creates a custom parameter targeting rule for the specified site.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/targeting/custom/create.do

Creates a custom parameter targeting rule for the specified site. Supports three custom types: EXPRESSION (a boolean expression like ($p1==1 || $p1=='a') && $p2>=12), VALUE (exact match on a parameter), and SUBSTRING (partial match). When customType is VALUE or SUBSTRING, the operation and parameter fields specify how to compare. Returns the created targeting rule on success. Requires CUSTOM targeting permission.

Path Params

siteId integer required

Unique numeric ID of the site

3001

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

customValue string required

Custom targeting value or expression (e.g. ($p1==1 || $p1=='a') && $p2>=12)

premium_user

customType string

Custom target type — EXPRESSION, VALUE, or SUBSTRING (optional)

VALUE

operation string

Comparison operation — EQUALS, NOT_EQUALS, CONTAINS, or NOT_CONTAINS (optional, used with VALUE/SUBSTRING)

EQUALS

parameter string

Parameter name for the operation comparison (optional, used with VALUE/SUBSTRING)

segment

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Site not found

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/custom/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'rule=INCLUDE' \
  --data-urlencode 'customValue=premium_user' \
  --data-urlencode 'customType=VALUE' \
  --data-urlencode 'operation=EQUALS' \
  --data-urlencode 'parameter=segment'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/custom/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"rule": "INCLUDE", "customValue": "premium_user", "customType": "VALUE", "operation": "EQUALS", "parameter": "segment"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/custom/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"rule":"INCLUDE","customValue":"premium_user","customType":"VALUE","operation":"EQUALS","parameter":"segment"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/custom/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("rule=INCLUDE&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment"))
    .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/site/3001/targeting/custom/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["rule"] = "INCLUDE", ["customValue"] = "premium_user", ["customType"] = "VALUE", ["operation"] = "EQUALS", ["parameter"] = "segment" });

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/site/3001/targeting/custom/create.do", strings.NewReader(`rule=INCLUDE&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment`))
	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/site/3001/targeting/custom/create.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, 'rule=INCLUDE&customValue=premium_user&customType=VALUE&operation=EQUALS&parameter=segment');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/site/3001/targeting/custom/create.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('rule' => "INCLUDE", 'customValue' => "premium_user", 'customType' => "VALUE", 'operation' => "EQUALS", 'parameter' => "segment")

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