Get Custom Payout/Revenue

Retrieve a single custom payout/revenue setting by its ID.

GET /networks/custom/payoutrevenue/{settingId}

Get Custom Payout/Revenue by ID

cURL

curl --request GET \
  --url https://api.eflow.team/v1/networks/custom/payoutrevenue/{settingId} \
  --header 'X-Eflow-Api-Key: <api-key>'

200

{
  "network_custom_payout_revenue_setting_id": 123,
  "network_id": 123,
  "network_offer_id": 123,
  "network_offer_payout_revenue_id": 123,
  "name": "<string>",
  "custom_setting_status": "active",
  "is_apply_all_affiliates": true,
  "is_custom_payout_enabled": true,
  "payout_type": "blank",
  "payout_amount": 123,
  "payout_percentage": 123,
  "is_custom_revenue_enabled": true,
  "revenue_type": "blank",
  "revenue_amount": 123,
  "revenue_percentage": 123,
  "description": "<string>",
  "public_description": "<string>",
  "is_postback_disabled": true,
  "date_valid_from": "<string>",
  "date_valid_to": "<string>",
  "is_apply_specific_offer_urls": true,
  "network_affiliate_ids": [
    123
  ],
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "network_offer_url_ids": [
    123
  ],
  "relationship": {
    "affiliates": {
      "total": 123,
      "entries": [
        {
          "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>"
    },
    "payout_revenue": {
      "network_offer_payout_revenue_id": 123,
      "network_id": 123,
      "network_offer_id": 123,
      "entry_name": "<string>",
      "payout_type": "<string>",
      "payout_amount": 123,
      "payout_percentage": 123,
      "revenue_type": "<string>",
      "revenue_amount": 123,
      "revenue_percentage": 123,
      "is_default": true,
      "is_private": true,
      "is_postback_disabled": true,
      "is_enforce_caps": true,
      "time_created": 1734455015,
      "global_advertiser_event_id": 123,
      "is_must_approve_conversion": true,
      "is_allow_duplicate_conversion": true,
      "is_email_attribution_default_event": true,
      "remote_offer_resource": {}
    },
    "currency_id": "<string>",
    "ruleset": {},
    "variables": {
      "total": 123,
      "entries": [
        {
          "network_custom_payout_revenue_setting_variable_id": 123,
          "network_custom_payout_revenue_setting_id": 123,
          "comparison_method": "<string>",
          "variable": "<string>",
          "variable_value": "<string>",
          "variable_secondary_value": "<string>"
        }
      ]
    },
    "offer_urls": [
      {
        "network_offer_url_id": 123,
        "network_id": 123,
        "network_offer_id": 123,
        "name": "<string>"
      }
    ]
  }
}

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 payout/revenue setting identifier.

Query Parameters

relationship · enum<string>

Set to all to include expanded relationship data (ruleset, variables, offer_urls) in the response.

Available options: all

Response

200 - application/json

network_custom_payout_revenue_setting_id · integer

Unique custom payout/revenue setting ID.

network_id · integer

Network ID.

network_offer_id · integer

Associated offer ID.

network_offer_payout_revenue_id · integer

The offer's payout/revenue config ID (0 = base conversion).

name · string

Display name for this custom setting.

custom_setting_status · enum<string>

Setting status.

Available options: active, inactive

is_apply_all_affiliates · boolean

Whether this setting applies to all affiliates, including ones who have yet to be created.

is_custom_payout_enabled · boolean

Whether custom payout is enabled.

payout_type · enum<string>

Payout pricing model. blank when custom payout is not enabled.

Available options: blank, cpc, cpa, cpm, cps, cpa_cps, prv, cpa_sku, cps_sku, cpa_cps_sku, prv_sku

payout_amount · number<double>

Custom payout amount. Only relevant for a payout_type expressed in absolute values (cpa, cpa_cps, cpm, cpc).

payout_percentage · number

Payout percentage. Only relevant for a payout_type expressed in percentage (cps, cpa_cps, prv).

is_custom_revenue_enabled · boolean

Whether custom revenue is enabled.

revenue_type · enum<string>

Revenue pricing model. blank when custom revenue is not enabled.

Available options: blank, rpc, rpa, rpm, rps, rpa_rps, rpa_sku, rps_sku, rpa_rps_sku

revenue_amount · number<double>

Custom revenue amount. Only relevant for a revenue_type expressed in absolute values (rpa, rpa_rps, rpm, rpc).

revenue_percentage · number

Revenue percentage.

description · string

Internal description.

public_description · string

Public description visible to affiliates. Note that if the custom payout revenue completely overrides the base payout revenue settings (not regulated by dates, targeting, or variable rules), it will not appear as a "custom payout" setting for the affiliate, and this description will not be visible.

is_postback_disabled · boolean

Whether to disable partner postback firing when this custom setting takes effect. When true, partner postbacks will not fire for conversions matched by this setting.

date_valid_from · string

Start date for when this setting is active (YYYY-MM-DD). The custom setting will not apply before this date. Leave empty for no start date restriction.

date_valid_to · string

End date for when this setting expires (YYYY-MM-DD). The custom setting will not apply after this date. Leave empty for no end date restriction.

is_apply_specific_offer_urls · boolean

Whether this applies only to specific offer URLs.

network_affiliate_ids · integer[]

Array of affiliate IDs this setting applies to.

time_created · integer

Unix timestamp of creation.

Example:

1734455015

time_saved · integer

Unix timestamp of last update.

Example:

1734455015

network_offer_url_ids · integer[] | null

Array of offer URL IDs this setting applies to.

relationship · object

Show child attributes