Skip to main content
GET
Get Custom Scrub Rate by ID

Authorizations

X-Eflow-Api-Key
string
header
required

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

Path Parameters

settingId
integer
required

The custom scrub rate setting identifier.

Query Parameters

relationship
enum<string>

Set to all to include expanded relationship data (ruleset, variables) in the response. Without this parameter, only affiliate and offer are returned.

Available options:
all

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