Custom Payout & Revenues

Operations for custom payout and revenues

Find All

GET /v1/networks/custom/payoutrevenue

Filters

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

Value Description
network_offer_id Filter based on the offer id
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET 'https://api.eflow.team/v1/networks/custom/payoutrevenue' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json' 
Response
 {
    "custom_payout_revenue_settings": [
    {
        "network_custom_payout_revenue_setting_id": 0,
        "network_id": 0,
        "is_apply_all_affiliates": true,
        "network_affiliate_ids": null,
        "network_offer_id": 0,
        "name": "",
        "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_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": 0,
                "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"
        }
    }],
    "paging":
     {
         "page": 1,
         "page_size": 50,
         "total_count": 54
     }
 }

Find By ID

GET /v1/networks/custom/payoutrevenue/:settingId

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 the custom payout & revenue’s variables information
targeting Includes the custom payout & revenue’s targeting information

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request GET --url 'https://api.eflow.team/v1/networks/custom/payoutrevenue/<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": "",
        "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_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": 0,
                "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/payoutrevenue

network_offer_payout_revenue_id int

If it applies to the base conversion, the value should be 0. Otherwise, must be the unique Id of the event.

network_offer_id int

The offer id.

is_apply_all_affiliates boolean

Decides whether this custom payout revenue setting applies to all affiliates (include ones who have yet to be created).

network_affiliate_ids array[int]

Required only if is_apply_all_affiliates = false. Allows you to select only specific affiliate for this custom payout.

name string
description string
custom_setting_status string

The custom setting status. Can be either active or inactive

is_custom_payout_enabled boolean

You must at least enable one of: is_custom_payout_enabled, is_custom_revenue_enabled.

is_custom_revenue_enabled boolean

You must at least enable one of: is_custom_payout_enabled, is_custom_revenue_enabled.

payout_amount double
payout_percentage int
payout_type string

Allowed values: blank, cpc, cpa, cpm, cps, cpa_cps, prv, null_value.

revenue_amount double
revenue_percentage int
revenue_type string

Allowed values: blank, rpc, rpa, rpm, rps, rpa_rps.

is_postback_disabled boolean
date_valid_from string
date_valid_to string
ruleset object

List of rules for the payout/revenue.

platforms object array
platform_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

device_types object array
device_type_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

os_versions object array
platform_id int
os_version_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact, minimum, maximum.

brands object array
brand_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

browsers object array
browser_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

languages object array
browser_language_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

countries object array
country_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

regions object array
region_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

cities object array
city_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

dmas object array
dma_code int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

mobile_carriers object array
mobile_carrier_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

connection_types object array
connection_type_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

ips object array
ip_from string
ip_to string
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

is_block_proxy boolean
is_use_day_parting boolean
day_parting_apply_to string

Allowed values: user_timezone, selected_timezone, null_value.

day_parting_timezone_id int
days_parting object array
day_of_week int
start_hour int
start_minute int
end_hour int
end_minute int
isps object array
isp_from string
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

variables object array
variable string
variable_value string
comparison_method string

Allowed values: exact_match, contains, begins_with, ends_with, does_not_contain, does_not_match.

{
  "is_apply_all_affiliates": true,
  "network_affiliate_ids": [
    0
  ],
  "network_offer_id": 0,
  "name": "",
  "network_offer_payout_revenue_id": 0,
  "description": "",
  "custom_setting_status": "active",
  "is_custom_payout_enabled": true,
  "payout_amount": 0,
  "payout_percentage": 0,
  "payout_type": "blank",
  "is_custom_revenue_enabled": true,
  "revenue_amount": 0,
  "revenue_percentage": 0,
  "revenue_type": "blank",
  "is_postback_disabled": true,
  "date_valid_from": "",
  "date_valid_to": "",
  "ruleset": {
    "platforms": [
      {
        "platform_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "device_types": [
      {
        "device_type_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "os_versions": [
      {
        "platform_id": 0,
        "os_version_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "brands": [
      {
        "brand_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "browsers": [
      {
        "browser_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "languages": [
      {
        "browser_language_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "countries": [
      {
        "country_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "regions": [
      {
        "region_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "cities": [
      {
        "city_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "dmas": [
      {
        "dma_code": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "mobile_carriers": [
      {
        "mobile_carrier_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "connection_types": [
      {
        "connection_type_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "ips": [
      {
        "ip_from": "",
        "ip_to": "",
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "is_block_proxy": true,
    "is_use_day_parting": true,
    "day_parting_apply_to": "user_timezone",
    "day_parting_timezone_id": 0,
    "days_parting": [
      {
        "day_of_week": 0,
        "start_hour": 0,
        "start_minute": 0,
        "end_hour": 0,
        "end_minute": 0
      }
    ],
    "isps": [
      {
        "isp_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ]
  },
  "variables": [
    {
      "comparison_method": "exact_match",
      "variable": "",
      "variable_value": ""
    }
  ]
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/payoutrevenue' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "network_custom_payout_revenue_setting_id": 0,
  "network_id": 0,
  "is_apply_all_affiliates": true,
  "network_affiliate_ids": [
    0
  ],
  "network_offer_id": 0,
  "name": "",
  "network_offer_payout_revenue_id": 0,
  "description": "",
  "custom_setting_status": "active",
  "is_custom_payout_enabled": true,
  "payout_amount": 0,
  "payout_percentage": 0,
  "payout_type": "blank",
  "is_custom_revenue_enabled": true,
  "revenue_amount": 0,
  "revenue_percentage": 0,
  "revenue_type": "blank",
  "is_postback_disabled": true,
  "date_valid_from": "",
  "date_valid_to": "",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": {
      "total": 0,
      "entries": [
        {
          "network_affiliate_id": 0,
          "network_id": 0,
          "name": "",
          "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": 0,
          "referrer_id": 0
        }
      ]
    },
    "offer": {
      "network_offer_id": 0,
      "network_id": 0,
      "network_advertiser_id": 0,
      "network_offer_group_id": 0,
      "name": "",
      "offer_status": "active",
      "network_tracking_domain_id": 0,
      "visibility": "public",
      "currency_id": ""
    },
    "ruleset": {
      "network_id": 0,
      "network_ruleset_id": 0,
      "time_created": 0,
      "time_saved": 0,
      "platforms": [
        {
          "network_id": 0,
          "network_targeting_platform_id": 0,
          "platform_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "device_types": [
        {
          "network_id": 0,
          "network_targeting_device_type_id": 0,
          "device_type_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "os_versions": [
        {
          "network_id": 0,
          "network_targeting_os_version_id": 0,
          "platform_id": 0,
          "os_version_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "brands": [
        {
          "network_id": 0,
          "network_targeting_brand_id": 1,
          "brand_id": 7,
          "label": "Motorola",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "browsers": [
        {
          "network_id": 0,
          "network_targeting_browser_id": 0,
          "browser_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "languages": [
        {
          "network_id": 0,
          "network_targeting_browser_language_id": 0,
          "browser_language_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "countries": [
        {
          "network_id": 0,
          "network_targeting_country_id": 0,
          "country_id": 0,
          "label": "",
          "country_code": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "regions": [
        {
          "network_id": 0,
          "network_targeting_region_id": 0,
          "region_id": 0,
          "region_code": "",
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "cities": [
        {
          "network_id": 0,
          "network_targeting_city_id": 0,
          "city_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "dmas": [
        {
          "network_id": 0,
          "network_targeting_dma_id": 0,
          "dma_code": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "mobile_carriers": [
        {
          "network_id": 0,
          "network_targeting_mobile_carrier_id": 0,
          "mobile_carrier_id": 0,
          "label": "",
          "country_id": 0,
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "connection_types": [
        {
          "network_id": 0,
          "network_targeting_connection_type_id": 0,
          "connection_type_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "ips": [
        {
          "network_id": 0,
          "network_targeting_ip_id": 0,
          "ip_from": "",
          "ip_to": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "is_block_proxy": true,
      "is_use_day_parting": true,
      "day_parting_apply_to": "user_timezone",
      "day_parting_timezone_id": 0,
      "days_parting": [
        {
          "network_id": 0,
          "network_targeting_day_parting_id": 0,
          "day_of_week": 0,
          "start_hour": 0,
          "start_minute": 0,
          "end_hour": 0,
          "end_minute": 0
        }
      ],
      "isps": [
        {
          "network_id": 0,
          "network_targeting_isp_id": 0,
          "isp_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ]
    },
    "variables": {
      "total": 0,
      "entries": [
        {
          "network_custom_payout_revenue_setting_variable_id": 0,
          "network_custom_payout_revenue_setting_id": 0,
          "comparison_method": "exact_match",
          "variable": "",
          "variable_value": ""
        }
      ]
    },
    "payout_revenue": {
      "network_offer_payout_revenue_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "entry_name": "",
      "payout_type": "blank",
      "payout_amount": 0,
      "payout_percentage": 0,
      "revenue_type": "blank",
      "revenue_amount": 0,
      "revenue_percentage": 0,
      "is_default": true,
      "is_private": true,
      "is_postback_disabled": true,
      "is_enforce_caps": true,
      "time_created": 0,
      "global_advertiser_event_id": 0,
      "is_must_approve_conversion": true,
      "is_allow_duplicate_conversion": true
    },
    "currency_id": ""
  }
}

Update

PUT /v1/networks/custom/payoutrevenue/:settingId

network_offer_payout_revenue_id int

If it applies to the base conversion, the value should be 0. Otherwise, must be the unique Id of the event.

network_offer_id int

The offer id.

is_apply_all_affiliates boolean

Decides whether this custom payout revenue setting applies to all affiliates (include ones who have yet to be created).

network_affiliate_ids array[int]

Required only if is_apply_all_affiliates = false. Allows you to select only specific affiliate for this custom payout.

name string
description string
custom_setting_status string

The custom setting status. Can be either active or inactive

is_custom_payout_enabled boolean

You must at least enable one of: is_custom_payout_enabled, is_custom_revenue_enabled.

is_custom_revenue_enabled boolean

You must at least enable one of: is_custom_payout_enabled, is_custom_revenue_enabled.

payout_amount double
payout_percentage int
payout_type string

Allowed values: blank, cpc, cpa, cpm, cps, cpa_cps, prv, null_value.

revenue_amount double
revenue_percentage int
revenue_type string

Allowed values: blank, rpc, rpa, rpm, rps, rpa_rps.

is_postback_disabled boolean
date_valid_from string
date_valid_to string
ruleset object

List of rules for the payout/revenue.

platforms object array
platform_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

device_types object array
device_type_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

os_versions object array
platform_id int
os_version_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact, minimum, maximum.

brands object array
brand_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

browsers object array
browser_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

languages object array
browser_language_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

countries object array
country_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

regions object array
region_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

cities object array
city_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

dmas object array
dma_code int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

mobile_carriers object array
mobile_carrier_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

connection_types object array
connection_type_id int
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

ips object array
ip_from string
ip_to string
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

is_block_proxy boolean
is_use_day_parting boolean
day_parting_apply_to string

Allowed values: user_timezone, selected_timezone, null_value.

day_parting_timezone_id int
days_parting object array
day_of_week int
start_hour int
start_minute int
end_hour int
end_minute int
isps object array
isp_from string
targeting_type string

Allowed values: include, exclude.

match_type string

Allowed values: exact.

variables object array
variable string
variable_value string
comparison_method string

Allowed values: exact_match, contains, begins_with, ends_with, does_not_contain, does_not_match.

{
  "is_apply_all_affiliates": true,
  "network_affiliate_ids": [
    0
  ],
  "network_offer_id": 0,
  "name": "",
  "network_offer_payout_revenue_id": 0,
  "description": "",
  "custom_setting_status": "active",
  "is_custom_payout_enabled": true,
  "payout_amount": 0,
  "payout_percentage": 0,
  "payout_type": "blank",
  "is_custom_revenue_enabled": true,
  "revenue_amount": 0,
  "revenue_percentage": 0,
  "revenue_type": "blank",
  "is_postback_disabled": true,
  "date_valid_from": "",
  "date_valid_to": "",
  "ruleset": {
    "platforms": [
      {
        "platform_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "device_types": [
      {
        "device_type_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "os_versions": [
      {
        "platform_id": 0,
        "os_version_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "brands": [
      {
        "brand_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "browsers": [
      {
        "browser_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "languages": [
      {
        "browser_language_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "countries": [
      {
        "country_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "regions": [
      {
        "region_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "cities": [
      {
        "city_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "dmas": [
      {
        "dma_code": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "mobile_carriers": [
      {
        "mobile_carrier_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "connection_types": [
      {
        "connection_type_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "ips": [
      {
        "ip_from": "",
        "ip_to": "",
        "targeting_type": "include",
        "match_type": "exact"
      }
    ],
    "is_block_proxy": true,
    "is_use_day_parting": true,
    "day_parting_apply_to": "user_timezone",
    "day_parting_timezone_id": 0,
    "days_parting": [
      {
        "day_of_week": 0,
        "start_hour": 0,
        "start_minute": 0,
        "end_hour": 0,
        "end_minute": 0
      }
    ],
    "isps": [
      {
        "isp_id": 0,
        "targeting_type": "include",
        "match_type": "exact"
      }
    ]
  },
  "variables": [
    {
      "comparison_method": "exact_match",
      "variable": "",
      "variable_value": ""
    }
  ]
}

cURL
curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/custom/payoutrevenue/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "network_custom_payout_revenue_setting_id": 0,
  "network_id": 0,
  "is_apply_all_affiliates": true,
  "network_affiliate_ids": [
    0
  ],
  "network_offer_id": 0,
  "name": "",
  "network_offer_payout_revenue_id": 0,
  "description": "",
  "custom_setting_status": "active",
  "is_custom_payout_enabled": true,
  "payout_amount": 0,
  "payout_percentage": 0,
  "payout_type": "blank",
  "is_custom_revenue_enabled": true,
  "revenue_amount": 0,
  "revenue_percentage": 0,
  "revenue_type": "blank",
  "is_postback_disabled": true,
  "date_valid_from": "",
  "date_valid_to": "",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": {
      "total": 0,
      "entries": [
        {
          "network_affiliate_id": 0,
          "network_id": 0,
          "name": "",
          "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": 0,
          "referrer_id": 0
        }
      ]
    },
    "offer": {
      "network_offer_id": 0,
      "network_id": 0,
      "network_advertiser_id": 0,
      "network_offer_group_id": 0,
      "name": "",
      "offer_status": "active",
      "network_tracking_domain_id": 0,
      "visibility": "public",
      "currency_id": ""
    },
    "ruleset": {
      "network_id": 0,
      "network_ruleset_id": 0,
      "time_created": 0,
      "time_saved": 0,
      "platforms": [
        {
          "network_id": 0,
          "network_targeting_platform_id": 0,
          "platform_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "device_types": [
        {
          "network_id": 0,
          "network_targeting_device_type_id": 0,
          "device_type_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "os_versions": [
        {
          "network_id": 0,
          "network_targeting_os_version_id": 0,
          "platform_id": 0,
          "os_version_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "brands": [
        {
          "network_id": 0,
          "network_targeting_brand_id": 1,
          "brand_id": 7,
          "label": "Motorola",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "browsers": [
        {
          "network_id": 0,
          "network_targeting_browser_id": 0,
          "browser_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "languages": [
        {
          "network_id": 0,
          "network_targeting_browser_language_id": 0,
          "browser_language_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "countries": [
        {
          "network_id": 0,
          "network_targeting_country_id": 0,
          "country_id": 0,
          "label": "",
          "country_code": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "regions": [
        {
          "network_id": 0,
          "network_targeting_region_id": 0,
          "region_id": 0,
          "region_code": "",
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "cities": [
        {
          "network_id": 0,
          "network_targeting_city_id": 0,
          "city_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "dmas": [
        {
          "network_id": 0,
          "network_targeting_dma_id": 0,
          "dma_code": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "mobile_carriers": [
        {
          "network_id": 0,
          "network_targeting_mobile_carrier_id": 0,
          "mobile_carrier_id": 0,
          "label": "",
          "country_id": 0,
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "connection_types": [
        {
          "network_id": 0,
          "network_targeting_connection_type_id": 0,
          "connection_type_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "ips": [
        {
          "network_id": 0,
          "network_targeting_ip_id": 0,
          "ip_from": "",
          "ip_to": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "is_block_proxy": true,
      "is_use_day_parting": true,
      "day_parting_apply_to": "user_timezone",
      "day_parting_timezone_id": 0,
      "days_parting": [
        {
          "network_id": 0,
          "network_targeting_day_parting_id": 0,
          "day_of_week": 0,
          "start_hour": 0,
          "start_minute": 0,
          "end_hour": 0,
          "end_minute": 0
        }
      ],
      "isps": [
        {
          "network_id": 0,
          "network_targeting_isp_id": 0,
          "isp_id": 0,
          "label": "",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ]
    },
    "variables": {
      "total": 0,
      "entries": [
        {
          "network_custom_payout_revenue_setting_variable_id": 0,
          "network_custom_payout_revenue_setting_id": 0,
          "comparison_method": "exact_match",
          "variable": "",
          "variable_value": ""
        }
      ]
    },
    "payout_revenue": {
      "network_offer_payout_revenue_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "entry_name": "",
      "payout_type": "blank",
      "payout_amount": 0,
      "payout_percentage": 0,
      "revenue_type": "blank",
      "revenue_amount": 0,
      "revenue_percentage": 0,
      "is_default": true,
      "is_private": true,
      "is_postback_disabled": true,
      "is_enforce_caps": true,
      "time_created": 0,
      "global_advertiser_event_id": 0,
      "is_must_approve_conversion": true,
      "is_allow_duplicate_conversion": true
    },
    "currency_id": ""
  }
}

Delete

DELETE /v1/networks/custom/payoutrevenue/: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/payoutrevenue/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
Response
{
  "result": true
}

Patch

PATCH /v1/networks/custom/payoutrevenue

network_custom_payout_revenue_setting_ids array[int]

List of network custom payout/revenue setting ids separated by comas.

fields array[object]

List of fields to update.

field_type string

Allowed values: custom_setting_status, date_valid_from, date_valid_to, description, is_apply_all_affiliates, is_custom_payout_enabled, is_custom_revenue_enabled, name, network_affiliate_ids, network_offer_id, payout_amount, payout_percentage, payout_type, revenue_amount, revenue_percentage, revenue_type, is_postback_disabled, variables, ruleset_platforms, ruleset_device_types, ruleset_os_versions, ruleset_browsers, ruleset_languages, ruleset_countries, ruleset_regions, ruleset_cities, ruleset_dmas, ruleset_mobile_carriers, ruleset_isps, ruleset_connection_types, ruleset_ips, ruleset_is_block_proxy.

field_value dynamic

WARNING: dynamic value, please see endpoint docs

{
  "network_custom_payout_revenue_setting_ids": [
    0
  ],
  "fields": [
    {
      "field_type": "custom_setting_status",
      "field_value": ""
    }
  ]
}

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