Custom Scrub Rates

Operations for custom scrub rates

Find All

GET /v1/networks/custom/scrubrate

Filters

This endpoint supports basic filtering. Refer to API filters page for usage.

Value Description
network_offer_id Filter based on the offer id
network_affiliate_id Filter based on the affiliate id
custom_setting_status Filter based on the custom settimg status
scrub_rate_status Filter based on the custom scrub rate status
time_created Filter based on the creation time
time_saved Filter based on the last update time

Relationships

This endpoint supports the following additional relationships. Refer to our User Guide for usage.

This endpoint supports additional relationships. You can ask for them using the relationship query parameter. Multiple relationships can be supplied repeating the relationship query parameter.

Value Description
variables Includes variable information

cURL
curl --request GET 'https://api.eflow.team/v1/networks/custom/scrubrate' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json' 
Response
 {
   "custom_scrub_rate_settings": [
     {
       "network_custom_scrub_rate_setting_id": 0,
       "network_id": 0,
       "network_affiliate_id": 0,
       "network_offer_id": 0,
       "custom_setting_status": "active",
       "name": "Custom Scrub Rate Example",
       "scrub_rate_status": "rejected",
       "scrub_rate_percentage": 0,
       "time_created": 0,
       "time_saved": 0,
       "relationship": {
         "affiliate": {
           "network_affiliate_id": 0,
           "network_id": 0,
           "name": "Affiliate Example",
           "account_status": "active",
           "network_employee_id": 0,
           "internal_notes": "",
           "has_notifications": true,
           "network_traffic_source_id": 0,
           "account_executive_id": 0,
           "adress_id": 0,
           "default_currency_id": "",
           "is_contact_address_enabled": true,
           "enable_media_cost_tracking_links": true,
           "time_created": 0,
           "time_saved": 1493662524,
           "referrer_id": 1493662524
         },
         "offer": {
           "network_offer_id": 0,
           "network_id": 0,
           "network_advertiser_id": 0,
           "network_offer_group_id": 0,
           "name": "Offer Example",
           "offer_status": "active",
           "network_tracking_domain_id": 0,
           "visibility": "public",
           "currency_id": ""
         },
         "variables": {
           "total": 0,
           "entries": [
             {
               "network_custom_scrub_rate_setting_variable_id": 0,
               "network_custom_scrub_rate_setting_id": 0,
               "comparison_method": "begins_with",
               "variable": "",
               "variable_value": ""
             }
           ]
         }
       }
     }
   ]
 }

Find By ID

GET /v1/networks/custom/scrubrate/:settingId

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request GET --url 'https://api.eflow.team/v1/networks/custom/scrubrate/<INSERT SETTING ID>' \
--header 'x-eflow-api-key: <INSERT API KEY>' \
--header 'content-type: application/json' 
Response
{
    "network_custom_payout_revenue_setting_id": 0,
    "network_id": 0,
    "is_apply_all_affiliates": true,
    "network_affiliate_ids": null,
    "network_offer_id": 0,
    "name": "Custom Payout Revenue Example",
    "network_offer_payout_revenue_id": 0,
    "description": "",
    "custom_setting_status": "active",
    "is_custom_payout_enabled": false,
    "payout_amount": 0,
    "payout_percentage": 0,
    "payout_type": "blank",
    "is_custom_revenue_enabled": true,
    "revenue_amount": 0,
    "revenue_percentage": 0,
    "revenue_type": "rpa",
    "is_postback_disabled": false,
    "date_valid_from": "",
    "date_valid_to": "",
    "time_created": 1594403766,
    "time_saved": 1594403766,
    "relationship":
    {
        "affiliates":
        {
            "total": 0,
            "entries": []
        },
        "offer":
        {
            "network_offer_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 0,
            "visibility": "public",
            "currency_id": "USD"
        },
        "payout_revenue":
        {
            "network_offer_payout_revenue_id": 0,
            "network_id": 0,
            "network_offer_id": 0,
            "entry_name": "",
            "payout_type": "cpa",
            "payout_amount": 0,
            "payout_percentage": 0,
            "revenue_type": "rpa",
            "revenue_amount": 1,
            "revenue_percentage": 0,
            "is_default": true,
            "is_private": false,
            "is_postback_disabled": false,
            "is_enforce_caps": true,
            "time_created": 1594390711,
            "global_advertiser_event_id": 0,
            "is_must_approve_conversion": false,
            "is_allow_duplicate_conversion": true,
            "is_email_attribution_default_event": false,
            "remote_offer_resource":
            {
                "network_offer_id": 0,
                "network_id": 0,
                "resource_type": "",
                "remote_resource_id": "",
                "resource_id": 0,
                "last_value_md5": "",
                "json_config": "",
                "json_data": "",
                "time_created": 0,
                "time_saved": 0
            }
        },
        "currency_id": "USD"
    }
}

Create

POST /v1/networks/custom/scrubrate

network_affiliate_id int

The affiliate id.

network_offer_id int

The offer id.

custom_setting_status string

The custom setting status. Can be either active or inactive

name string

The custom cap setting name.

scrub_rate_status string

The scrub rate status. Can be one of the following values: “rejected”, “pending”, “null_value”

scrub_rate_percentage int

The scrub rate percentage.

variables object array

List of variables for the scrub rate.

comparison_method string

The type of comparison to use. Can be one of the following values: “begins_with”, “ends_with”, “exact_match”, “contains”, “is_present”

variable string

The scrub rate variable. From “sub1” to “sub5” and “sourceId”

variable_value string

The value to use for comparison.

{
  "network_affiliate_id": 0,
  "network_offer_id": 0,
  "custom_setting_status": "active",
  "name": "Custom Scrub Rate Example",
  "scrub_rate_status": "rejected",
  "scrub_rate_percentage": 0,
  "variables": [
    {
      "comparison_method": "begins_with",
      "variable": "",
      "variable_value": ""
    }
  ]
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/scrubrate' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
    "network_custom_scrub_rate_setting_id": 0,
    "network_id": 0,
    "network_affiliate_id": 0,
    "network_offer_id": 0,
    "custom_setting_status": "active",
    "name": "Custom Scrub Rate Example",
    "scrub_rate_status": "rejected",
    "scrub_rate_percentage": 0,
    "time_created": 1594668150,
    "time_saved": 1594668150,
    "relationship":
    {
        "affiliate":
        {
            "network_affiliate_id": 0,
            "network_id": 0,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 0,
            "internal_notes": "",
            "has_notifications": false,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "USD",
            "is_contact_address_enabled": false,
            "enable_media_cost_tracking_links": true,
            "time_created": 1594390710,
            "time_saved": 1594390710,
            "referrer_id": 0
        },
        "offer":
        {
            "network_offer_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 0,
            "visibility": "public",
            "currency_id": "USD"
        }
    }
}

Update

PUT /v1/networks/custom/scrubrate/:settingId

network_affiliate_id int

The affiliate id.

network_offer_id int

The offer id.

custom_setting_status string

The custom setting status. Can be either active or inactive

name string

The custom scrub rate setting name.

scrub_rate_status string

The scrub rate status. Can be one of the following values: “rejected”, “pending”, “null_value”

scrub_rate_percentage int

The scrub rate percentage.

variables object array

List of variables for the scrub rate.

comparison_method string

The type of comparison to use. Can be one of the following values: “begins_with”, “ends_with”, “exact_match”, “contains”, “is_present”

variable string

The scrub rate variable. From “sub1” to “sub5” and “sourceId”

variable_value string

The value to use for comparison.

{
  "network_affiliate_id": 0,
  "network_offer_id": 0,
  "custom_setting_status": "active",
  "name": "Custom Scrub Rate Example",
  "scrub_rate_status": "rejected",
  "scrub_rate_percentage": 0,
  "variables": [
    {
      "comparison_method": "begins_with",
      "variable": "",
      "variable_value": ""
    }
  ]
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/scrubrate/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
    "network_custom_scrub_rate_setting_id": 0,
    "network_id": 0,
    "network_affiliate_id": 0,
    "network_offer_id": 0,
    "custom_setting_status": "active",
    "name": "Custom Scrub Rate Example",
    "scrub_rate_status": "pending",
    "scrub_rate_percentage": 0,
    "time_created": 1594668150,
    "time_saved": 1594668150,
    "relationship":
    {
        "affiliate":
        {
            "network_affiliate_id": 0,
            "network_id": 0,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 0,
            "internal_notes": "",
            "has_notifications": false,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "USD",
            "is_contact_address_enabled": false,
            "enable_media_cost_tracking_links": true,
            "time_created": 1594390710,
            "time_saved": 1594390710,
            "referrer_id": 0
        },
        "offer":
        {
            "network_offer_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 0,
            "visibility": "public",
            "currency_id": "USD"
        }
    }
}

Delete

DELETE /v1/networks/custom/scrubrate/:settingId

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request DELETE \
  --url 'https://api.eflow.team/v1/networks/custom/scrubrate/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
Response
{
  "result": true
}

Patch

PATCH /v1/networks/custom/scrubrate

network_custom_scrub_rate_setting_ids array[int]

List of network custom scrub rate setting ids separated by comas.

fields array[object]

List of fields to update.

field_type string

Allowed values: custom_setting_status, name, network_affiliate_id, network_offer_id, scrub_rate_status, scrub_rate_percentage, variables

field_value dynamic

WARNING: dynamic value, please see endpoint docs

{
  "network_custom_scrub_rate_setting_ids": [
    0
  ],
  "fields": [
    {
      "field_type": "",
      "field_value": ""
    }
  ]
}

cURL
curl --request PATCH \
  --url 'https://api.eflow.team/v1/networks/custom/scrubrate' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "result": true
}