Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Custom Scrub Rates

Get Custom Scrub Rate by ID

Retrieve a single custom scrub rate setting by its ID.

get/networks/custom/scrubrate/{settingId}

Path parameters

settingIdinteger required

The custom scrub rate setting identifier.

Query parameters

relationship'all'

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

Response

network_custom_scrub_rate_setting_idinteger

Unique custom scrub rate setting ID.

network_idinteger

Network ID.

network_offer_idinteger

Associated offer ID.

network_affiliate_idinteger

Associated affiliate ID.

namestring

Display name for this custom scrub rate setting.

custom_setting_status'active' | 'inactive'

Setting status.

scrub_rate_percentageinteger

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'rejected' | 'pending'

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

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "affiliate": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  }
}