curl --request POST \
--url https://api.eflow.team/v1/networks/customervalue/rules \
--header 'Content-Type: application/json' \
--header 'X-Eflow-Api-Key: <api-key>' \
--data '
{
"name": "Third purchase bonus",
"status": "active",
"segmentation": "shared",
"offer_ids": [
33
],
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "month",
"outcome_type": "bonus",
"outcome_trigger": "instant",
"goals": [
{
"metric": "conversion",
"operator": "greater_than",
"value": "2"
}
],
"payout_method": "model",
"payout_type": "cpa",
"payout_value": 5,
"revenue_method": "model",
"revenue_type": "rpa",
"revenue_value": 8,
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value"
}
]
}
'import requests
url = "https://api.eflow.team/v1/networks/customervalue/rules"
payload = {
"name": "Third purchase bonus",
"status": "active",
"segmentation": "shared",
"offer_ids": [33],
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "month",
"outcome_type": "bonus",
"outcome_trigger": "instant",
"goals": [
{
"metric": "conversion",
"operator": "greater_than",
"value": "2"
}
],
"payout_method": "model",
"payout_type": "cpa",
"payout_value": 5,
"revenue_method": "model",
"revenue_type": "rpa",
"revenue_value": 8,
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value"
}
]
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Third purchase bonus',
status: 'active',
segmentation: 'shared',
offer_ids: [33],
start_date: '2026-08-01',
end_date: '2026-12-31',
cycle_type: 'month',
outcome_type: 'bonus',
outcome_trigger: 'instant',
goals: [{metric: 'conversion', operator: 'greater_than', value: '2'}],
payout_method: 'model',
payout_type: 'cpa',
payout_value: 5,
revenue_method: 'model',
revenue_type: 'rpa',
revenue_value: 8,
progress_settings: [{metric: 'conversions', condition: 'any_value'}]
})
};
fetch('https://api.eflow.team/v1/networks/customervalue/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/networks/customervalue/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Third purchase bonus',
'status' => 'active',
'segmentation' => 'shared',
'offer_ids' => [
33
],
'start_date' => '2026-08-01',
'end_date' => '2026-12-31',
'cycle_type' => 'month',
'outcome_type' => 'bonus',
'outcome_trigger' => 'instant',
'goals' => [
[
'metric' => 'conversion',
'operator' => 'greater_than',
'value' => '2'
]
],
'payout_method' => 'model',
'payout_type' => 'cpa',
'payout_value' => 5,
'revenue_method' => 'model',
'revenue_type' => 'rpa',
'revenue_value' => 8,
'progress_settings' => [
[
'metric' => 'conversions',
'condition' => 'any_value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/customervalue/rules"
payload := strings.NewReader("{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/networks/customervalue/rules")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/customervalue/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"network_id": 1,
"rule_id": 87,
"name": "Third purchase bonus",
"status": "active",
"state": "scheduled",
"stopped_running_reason": "default",
"segmentation": "shared",
"offer_ids": [
123
],
"advertiser_ids": [
123
],
"affiliate_ids": [
123
],
"payout_revenue_id": 123,
"timezone_id": 67,
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "rule_duration",
"cycle_duration": 30,
"goals": [
{
"metric": "revenue",
"operator": "greater_than",
"value": "2",
"goal_id": 123,
"metric_data_point_identifier": "<string>",
"logic": "min"
}
],
"outcome_type": "substitution",
"outcome_trigger": "instant",
"outcome_payout_revenue_id": 123,
"payout_method": "disabled",
"payout_modifier": "increase",
"payout_type": "cpa",
"payout_value": 5,
"payout_percentage": 123,
"payout_data_point_identifier": "<string>",
"payout_data_point_calculation": "accumulated",
"revenue_method": "disabled",
"revenue_modifier": "increase",
"revenue_type": "rpa",
"revenue_value": 8,
"revenue_percentage": 123,
"revenue_data_point_identifier": "<string>",
"revenue_data_point_calculation": "accumulated",
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value",
"setting_id": 123,
"data_point_identifier": "<string>"
}
],
"relationship": {
"scoped_payout_revenue_name": "<string>",
"tied_payout_revenue_name": "<string>"
},
"time_created": 1734455015,
"time_saved": 1734455015
}Create Rule
Create a Customer Value rule. See Customer Value for how goals, cycles, and outcomes fit together and which field combinations are valid.
curl --request POST \
--url https://api.eflow.team/v1/networks/customervalue/rules \
--header 'Content-Type: application/json' \
--header 'X-Eflow-Api-Key: <api-key>' \
--data '
{
"name": "Third purchase bonus",
"status": "active",
"segmentation": "shared",
"offer_ids": [
33
],
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "month",
"outcome_type": "bonus",
"outcome_trigger": "instant",
"goals": [
{
"metric": "conversion",
"operator": "greater_than",
"value": "2"
}
],
"payout_method": "model",
"payout_type": "cpa",
"payout_value": 5,
"revenue_method": "model",
"revenue_type": "rpa",
"revenue_value": 8,
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value"
}
]
}
'import requests
url = "https://api.eflow.team/v1/networks/customervalue/rules"
payload = {
"name": "Third purchase bonus",
"status": "active",
"segmentation": "shared",
"offer_ids": [33],
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "month",
"outcome_type": "bonus",
"outcome_trigger": "instant",
"goals": [
{
"metric": "conversion",
"operator": "greater_than",
"value": "2"
}
],
"payout_method": "model",
"payout_type": "cpa",
"payout_value": 5,
"revenue_method": "model",
"revenue_type": "rpa",
"revenue_value": 8,
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value"
}
]
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Third purchase bonus',
status: 'active',
segmentation: 'shared',
offer_ids: [33],
start_date: '2026-08-01',
end_date: '2026-12-31',
cycle_type: 'month',
outcome_type: 'bonus',
outcome_trigger: 'instant',
goals: [{metric: 'conversion', operator: 'greater_than', value: '2'}],
payout_method: 'model',
payout_type: 'cpa',
payout_value: 5,
revenue_method: 'model',
revenue_type: 'rpa',
revenue_value: 8,
progress_settings: [{metric: 'conversions', condition: 'any_value'}]
})
};
fetch('https://api.eflow.team/v1/networks/customervalue/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/networks/customervalue/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Third purchase bonus',
'status' => 'active',
'segmentation' => 'shared',
'offer_ids' => [
33
],
'start_date' => '2026-08-01',
'end_date' => '2026-12-31',
'cycle_type' => 'month',
'outcome_type' => 'bonus',
'outcome_trigger' => 'instant',
'goals' => [
[
'metric' => 'conversion',
'operator' => 'greater_than',
'value' => '2'
]
],
'payout_method' => 'model',
'payout_type' => 'cpa',
'payout_value' => 5,
'revenue_method' => 'model',
'revenue_type' => 'rpa',
'revenue_value' => 8,
'progress_settings' => [
[
'metric' => 'conversions',
'condition' => 'any_value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/customervalue/rules"
payload := strings.NewReader("{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/networks/customervalue/rules")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/customervalue/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Third purchase bonus\",\n \"status\": \"active\",\n \"segmentation\": \"shared\",\n \"offer_ids\": [\n 33\n ],\n \"start_date\": \"2026-08-01\",\n \"end_date\": \"2026-12-31\",\n \"cycle_type\": \"month\",\n \"outcome_type\": \"bonus\",\n \"outcome_trigger\": \"instant\",\n \"goals\": [\n {\n \"metric\": \"conversion\",\n \"operator\": \"greater_than\",\n \"value\": \"2\"\n }\n ],\n \"payout_method\": \"model\",\n \"payout_type\": \"cpa\",\n \"payout_value\": 5,\n \"revenue_method\": \"model\",\n \"revenue_type\": \"rpa\",\n \"revenue_value\": 8,\n \"progress_settings\": [\n {\n \"metric\": \"conversions\",\n \"condition\": \"any_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"network_id": 1,
"rule_id": 87,
"name": "Third purchase bonus",
"status": "active",
"state": "scheduled",
"stopped_running_reason": "default",
"segmentation": "shared",
"offer_ids": [
123
],
"advertiser_ids": [
123
],
"affiliate_ids": [
123
],
"payout_revenue_id": 123,
"timezone_id": 67,
"start_date": "2026-08-01",
"end_date": "2026-12-31",
"cycle_type": "rule_duration",
"cycle_duration": 30,
"goals": [
{
"metric": "revenue",
"operator": "greater_than",
"value": "2",
"goal_id": 123,
"metric_data_point_identifier": "<string>",
"logic": "min"
}
],
"outcome_type": "substitution",
"outcome_trigger": "instant",
"outcome_payout_revenue_id": 123,
"payout_method": "disabled",
"payout_modifier": "increase",
"payout_type": "cpa",
"payout_value": 5,
"payout_percentage": 123,
"payout_data_point_identifier": "<string>",
"payout_data_point_calculation": "accumulated",
"revenue_method": "disabled",
"revenue_modifier": "increase",
"revenue_type": "rpa",
"revenue_value": 8,
"revenue_percentage": 123,
"revenue_data_point_identifier": "<string>",
"revenue_data_point_calculation": "accumulated",
"progress_settings": [
{
"metric": "conversions",
"condition": "any_value",
"setting_id": 123,
"data_point_identifier": "<string>"
}
],
"relationship": {
"scoped_payout_revenue_name": "<string>",
"tied_payout_revenue_name": "<string>"
},
"time_created": 1734455015,
"time_saved": 1734455015
}name is the only always-required field, but the rest of the payload has to be internally consistent — a bonus outcome needs goals, an end_of_cycle trigger needs an outcome_payout_revenue_id, and every data point you reference must be active. See Customer Value for how the parts fit together and the full list of constraints.Authorizations
The Everflow API key generated from the Control Center > Security.
Body
Display name of the rule.
255"Third purchase bonus"
Unique rule ID. Assigned on creation; required when updating.
87
Whether the rule is enabled. An inactive rule never evaluates, whatever its state.
active, inactive How a customer's accumulated history is partitioned. shared tracks one history per customer across everything in scope; the other values track a separate history per partner, per offer, per advertiser, or per combination, so the same customer can progress independently in each.
shared, affiliate, offer, advertiser, affiliate_offer, affiliate_advertiser Offers the rule applies to. Empty means every offer. Mutually exclusive with advertiser_ids.
Advertisers the rule applies to, covering all of their offers. Empty means every advertiser. Ignored when offer_ids is set.
Partners the rule applies to. Empty means every partner.
Restricts the rule to a single event (payout/revenue entry) of the offer in offer_ids. 0 means the rule applies to the offer's base conversion and all of its events.
Timezone used to interpret start_date, end_date, and calendar cycle boundaries. Defaults to the network's timezone.
67
Inclusive start date, yyyy-MM-dd. Empty means the rule starts as soon as it is created.
"2026-08-01"
Exclusive end date, yyyy-MM-dd. Must be after start_date. Empty means the rule never expires.
"2026-12-31"
When the customer's accumulated totals reset to zero. Calendar cycles (day, week, month, quarter) reset on the boundary in the rule's timezone. rule_duration never resets — the whole rule is a single cycle. from_first_conversion never resets either; instead the rule stops applying to a customer cycle_duration days after that customer's first conversion.
day, week, month, quarter, rule_duration, from_first_conversion Length of the cycle in days. Required and at least 1 when cycle_type is from_first_conversion; ignored otherwise.
30
Conditions the customer's accumulated totals must satisfy for the outcome to apply, evaluated over the whole history rather than against a single conversion. All goals must be satisfied. A rule may only be goalless when cycle_type is from_first_conversion and outcome_type is substitution.
Show child attributes
Show child attributes
How the outcome is applied. Each incoming conversion is added to the customer's history before the goals are checked, so the outcome lands on the conversion being processed when the history first satisfies them. substitution replaces that conversion's payout and revenue. bonus records a separate bonus conversion on top of it, leaving it untouched.
substitution, bonus When a bonus outcome is granted. instant grants it on the incoming conversion that brought the history to the goals; end_of_cycle grants it once when the cycle closes, aggregating the whole cycle. Required when outcome_type is bonus.
instant, end_of_cycle The event the bonus conversion is recorded against. Optional for an instant trigger — omit it to tie the bonus to the incoming event — and required for end_of_cycle.
How the payout is computed. disabled leaves the payout untouched, modifier adjusts the original payout, model computes a new payout from a payout type, and data_point derives it from a numeric data point. At least one of payout_method and revenue_method must be enabled.
disabled, modifier, model, data_point Direction of the adjustment when payout_method is modifier. increase and decrease treat payout_value as a percentage; flat_increase and flat_decrease treat it as an absolute amount.
increase, decrease, flat_increase, flat_decrease Payout model used when payout_method is model. Required in that case, and must be cpa when outcome_type is bonus. This is a narrower set than an offer payout type accepts — the _sku variants and cpc are rejected. Responses return blank for any other payout_method, which carries no payout type.
cpa, cps, cpa_cps, prv, cpm The payout amount, percentage, or per-unit rate, depending on payout_method. Cannot be negative, must not exceed 100 for a decrease modifier, and must be greater than 0 for data_point.
5
Percentage of sale amount (cps, cpa_cps) or of revenue (prv) used when payout_method is model.
Identifier of the numeric data point the payout is derived from. Required when payout_method is data_point; the data point must exist, be active, and have type number.
Which value of the data point to use — current for the value on the incoming conversion, accumulated for the total across the cycle. Defaults to accumulated. current is not allowed with an end_of_cycle outcome trigger.
current, accumulated How the revenue is computed. Mirrors payout_method. At least one of payout_method and revenue_method must be enabled.
disabled, modifier, model, data_point Direction of the adjustment when revenue_method is modifier. Mirrors payout_modifier.
increase, decrease, flat_increase, flat_decrease Revenue model used when revenue_method is model. Required in that case, and must be rpa when outcome_type is bonus. This is a narrower set than an offer revenue type accepts — the _sku variants and rpc are rejected. Responses return blank for any other revenue_method, which carries no revenue type.
rpa, rps, rpa_rps, rpm The revenue amount, percentage, or per-unit rate, depending on revenue_method. Same constraints as payout_value.
8
Percentage of sale amount used when revenue_method is model with rps or rpa_rps.
Identifier of the numeric data point the revenue is derived from. Required when revenue_method is data_point; the data point must exist, be active, and have type number.
Which value of the data point to use. Mirrors payout_data_point_calculation.
current, accumulated Exceptions to the cycle reset. Every metric and data point accumulates toward the rule's goals and, by default, resets at the end of each cycle; each entry here names one that carries its total over into the next cycle instead. Each metric may appear at most once. Only meaningful on calendar cycles — a rule_duration or from_first_conversion cycle never resets.
Show child attributes
Show child attributes
Response
Network ID.
1
Unique rule ID. Assigned on creation; required when updating.
87
Display name of the rule.
255"Third purchase bonus"
Whether the rule is enabled. An inactive rule never evaluates, whatever its state.
active, inactive Where the rule sits in its lifecycle, derived from its timeframe and configuration. scheduled before its start date, expired on or after its end date, stopped_running when its configuration is no longer valid to apply, and running otherwise. The state controls which fields an update can change.
scheduled, running, stopped_running, expired Why the rule is stopped_running. private_event means the rule defines a payout setting on a scoped event that is private; only revenue may be adjusted in that case.
default, private_event How a customer's accumulated history is partitioned. shared tracks one history per customer across everything in scope; the other values track a separate history per partner, per offer, per advertiser, or per combination, so the same customer can progress independently in each.
shared, affiliate, offer, advertiser, affiliate_offer, affiliate_advertiser Offers the rule applies to. Empty means every offer. Mutually exclusive with advertiser_ids.
Advertisers the rule applies to, covering all of their offers. Empty means every advertiser. Ignored when offer_ids is set.
Partners the rule applies to. Empty means every partner.
Restricts the rule to a single event (payout/revenue entry) of the offer in offer_ids. 0 means the rule applies to the offer's base conversion and all of its events.
Timezone used to interpret start_date, end_date, and calendar cycle boundaries. Defaults to the network's timezone.
67
Inclusive start date, yyyy-MM-dd. Empty means the rule starts as soon as it is created.
"2026-08-01"
Exclusive end date, yyyy-MM-dd. Must be after start_date. Empty means the rule never expires.
"2026-12-31"
When the customer's accumulated totals reset to zero. Calendar cycles (day, week, month, quarter) reset on the boundary in the rule's timezone. rule_duration never resets — the whole rule is a single cycle. from_first_conversion never resets either; instead the rule stops applying to a customer cycle_duration days after that customer's first conversion.
day, week, month, quarter, rule_duration, from_first_conversion Length of the cycle in days. Required and at least 1 when cycle_type is from_first_conversion; ignored otherwise.
30
Conditions the customer's accumulated totals must satisfy for the outcome to apply, evaluated over the whole history rather than against a single conversion. All goals must be satisfied. A rule may only be goalless when cycle_type is from_first_conversion and outcome_type is substitution.
Show child attributes
Show child attributes
How the outcome is applied. Each incoming conversion is added to the customer's history before the goals are checked, so the outcome lands on the conversion being processed when the history first satisfies them. substitution replaces that conversion's payout and revenue. bonus records a separate bonus conversion on top of it, leaving it untouched.
substitution, bonus When a bonus outcome is granted. instant grants it on the incoming conversion that brought the history to the goals; end_of_cycle grants it once when the cycle closes, aggregating the whole cycle. Required when outcome_type is bonus.
instant, end_of_cycle The event the bonus conversion is recorded against. Optional for an instant trigger — omit it to tie the bonus to the incoming event — and required for end_of_cycle.
How the payout is computed. disabled leaves the payout untouched, modifier adjusts the original payout, model computes a new payout from a payout type, and data_point derives it from a numeric data point. At least one of payout_method and revenue_method must be enabled.
disabled, modifier, model, data_point Direction of the adjustment when payout_method is modifier. increase and decrease treat payout_value as a percentage; flat_increase and flat_decrease treat it as an absolute amount.
increase, decrease, flat_increase, flat_decrease Payout model used when payout_method is model. Required in that case, and must be cpa when outcome_type is bonus. This is a narrower set than an offer payout type accepts — the _sku variants and cpc are rejected. Responses return blank for any other payout_method, which carries no payout type.
cpa, cps, cpa_cps, prv, cpm The payout amount, percentage, or per-unit rate, depending on payout_method. Cannot be negative, must not exceed 100 for a decrease modifier, and must be greater than 0 for data_point.
5
Percentage of sale amount (cps, cpa_cps) or of revenue (prv) used when payout_method is model.
Identifier of the numeric data point the payout is derived from. Required when payout_method is data_point; the data point must exist, be active, and have type number.
Which value of the data point to use — current for the value on the incoming conversion, accumulated for the total across the cycle. Defaults to accumulated. current is not allowed with an end_of_cycle outcome trigger.
current, accumulated How the revenue is computed. Mirrors payout_method. At least one of payout_method and revenue_method must be enabled.
disabled, modifier, model, data_point Direction of the adjustment when revenue_method is modifier. Mirrors payout_modifier.
increase, decrease, flat_increase, flat_decrease Revenue model used when revenue_method is model. Required in that case, and must be rpa when outcome_type is bonus. This is a narrower set than an offer revenue type accepts — the _sku variants and rpc are rejected. Responses return blank for any other revenue_method, which carries no revenue type.
rpa, rps, rpa_rps, rpm The revenue amount, percentage, or per-unit rate, depending on revenue_method. Same constraints as payout_value.
8
Percentage of sale amount used when revenue_method is model with rps or rpa_rps.
Identifier of the numeric data point the revenue is derived from. Required when revenue_method is data_point; the data point must exist, be active, and have type number.
Which value of the data point to use. Mirrors payout_data_point_calculation.
current, accumulated Exceptions to the cycle reset. Every metric and data point accumulates toward the rule's goals and, by default, resets at the end of each cycle; each entry here names one that carries its total over into the next cycle instead. Each metric may appear at most once. Only meaningful on calendar cycles — a rule_duration or from_first_conversion cycle never resets.
Show child attributes
Show child attributes
Related data, returned only when requested with the relationship query parameter.
Show child attributes
Show child attributes
Unix timestamp of creation.
1734455015
Unix timestamp of last update.
1734455015
Was this page helpful?