Create Custom Scrub Rate

POST /networks/custom/scrubrate

Create Custom Scrub Rate

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/custom/scrubrate \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "name": "Scrub Rate for Affiliate 7",
  "custom_setting_status": "active",
  "scrub_rate_percentage": 10,
  "scrub_rate_status": "rejected",
  "network_affiliate_id": 7,
  "network_offer_id": 1
}
'

200

{
  "network_custom_scrub_rate_setting_id": 123,
  "network_id": 123,
  "network_offer_id": 123,
  "network_affiliate_id": 123,
  "name": "<string>",
  "custom_setting_status": "active",
  "scrub_rate_percentage": 123,
  "scrub_rate_status": "rejected",
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 123,
      "network_id": 123,
      "name": "<string>",
      "account_status": "<string>",
      "network_employee_id": 123,
      "internal_notes": "<string>",
      "has_notifications": true,
      "network_traffic_source_id": 123,
      "account_executive_id": 123,
      "adress_id": 123,
      "default_currency_id": "<string>",
      "is_contact_address_enabled": true,
      "enable_media_cost_tracking_links": true,
      "time_created": 1734455015,
      "time_saved": 1734455015,
      "referrer_id": 123
    },
    "offer": {
      "network_offer_id": 123,
      "network_id": 123,
      "network_advertiser_id": 123,
      "network_offer_group_id": 123,
      "name": "<string>",
      "offer_status": "<string>",
      "network_tracking_domain_id": 123,
      "visibility": "<string>",
      "currency_id": "<string>"
    },
    "ruleset": {},
    "variables": {
      "total": 123,
      "entries": [
        {
          "network_custom_scrub_rate_setting_variable_id": 123,
          "network_custom_scrub_rate_setting_id": 123,
          "comparison_method": "<string>",
          "variable": "<string>",
          "variable_value": "<string>",
          "variable_secondary_value": "<string>"
        }
      ]
    }
  }
}

Create a custom scrub rate (throttle) setting associated with a specific affiliate/offer combination. The scrub rate mechanism automatically filters a percentage of conversions based on the configured percentage, optional variable matching rules, and targeting ruleset. Filtered conversions are either rejected or placed on hold depending on the configured scrub action.

Authorizations

X-Eflow-Api-Key · string · header · required

The Everflow API key generated from the Control Center > Security.

Body

application/json

network_offer_id · integer · required

The offer ID to create this custom scrub rate for.

network_affiliate_id · integer · required

The affiliate ID to apply this custom scrub rate to.

name · string · required

The custom scrub rate setting name.

custom_setting_status · enum<string> · required

The custom setting status. Can be either active or inactive.

Available options: active, inactive

scrub_rate_percentage · integer · required

The percentage of conversions that will be affected by this setting (0-100). Note that each conversion has the specified percentage chance of being scrubbed, rather than guaranteeing that exactly that percentage will be scrubbed.

scrub_rate_status · enum<string> · required

Status to assign to scrubbed conversions. pending marks them as pending for review; rejected rejects them immediately.

Available options: rejected, pending

variables · object[]

Optional list of variables that control which traffic segments the scrub rate applies to. Each variable defines a condition that must match for this scrub rate setting to take effect.

Show child attributes

ruleset · object

Targeting ruleset for this custom scrub rate setting. Allows you to restrict when this scrub rate is applied based on geographic, device, browser, and connection criteria. See the Ruleset guide for details.

Response

200 - application/json

network_custom_scrub_rate_setting_id · integer

Unique custom scrub rate setting ID.

network_id · integer

Network ID.

network_offer_id · integer

Associated offer ID.

network_affiliate_id · integer

Associated affiliate ID.

name · string

Display name for this custom scrub rate setting.

custom_setting_status · enum<string>

Setting status.

Available options: active, inactive

scrub_rate_percentage · integer

The percentage of conversions that will be affected by this setting (0-100). Note that each conversion has the specified percentage chance of being scrubbed, rather than guaranteeing that exactly that percentage will be scrubbed.

scrub_rate_status · enum<string>

How the setting affects the conversions it targets. pending marks conversions as pending; rejected rejects them immediately.

Available options: rejected, pending

time_created · integer

Unix timestamp of creation.

Example:

1734455015

time_saved · integer

Unix timestamp of last update.

Example:

1734455015

relationship · object

Show child attributes