Get Custom Scrub Rate by ID
curl --request GET \
--url https://api.eflow.team/v1/networks/custom/scrubrate/{settingId} \
--header 'X-Eflow-Api-Key: <api-key>'import requests
url = "https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}"
headers = {"X-Eflow-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};
fetch('https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}', 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/custom/scrubrate/{settingId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}")
.header("X-Eflow-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
}
}Custom Scrub Rates (Throttle)
Get Custom Scrub Rate
Retrieve a single custom scrub rate setting by its ID.
GET
/
networks
/
custom
/
scrubrate
/
{settingId}
Get Custom Scrub Rate by ID
curl --request GET \
--url https://api.eflow.team/v1/networks/custom/scrubrate/{settingId} \
--header 'X-Eflow-Api-Key: <api-key>'import requests
url = "https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}"
headers = {"X-Eflow-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};
fetch('https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}', 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/custom/scrubrate/{settingId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}")
.header("X-Eflow-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/custom/scrubrate/{settingId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>"
}
]
}
}
}Authorizations
The Everflow API key generated from the Control Center > Security.
Path Parameters
The custom scrub rate setting identifier.
Query Parameters
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
Unique custom scrub rate setting ID.
Network ID.
Associated offer ID.
Associated affiliate ID.
Display name for this custom scrub rate setting.
Setting status.
Available options:
active, inactive 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.
How the setting affects the conversions it targets. pending marks conversions as pending; rejected rejects them immediately.
Available options:
rejected, pending Unix timestamp of creation.
Example:
1734455015
Unix timestamp of last update.
Example:
1734455015
Show child attributes
Show child attributes
Was this page helpful?