Everflow – Network API

Docs: Advertisers

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/advertisers

Filters

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

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/advertisers' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "advertisers": [
        {
            "network_advertiser_id": 13,
            "network_id": 1,
            "name": "Gabielle Deleon Inc.",
            "account_status": "active",
            "network_employee_id": 1,
            "internal_notes": "",
            "address_id": 0,
            "is_contact_address_enabled": false,
            "sales_manager_id": 0,
            "is_expose_publisher_reporting_data": null,
            "default_currency_id": "USD",
            "platform_name": "",
            "platform_url": "",
            "platform_username": "",
            "reporting_timezone_id": 67,
            "accounting_contact_email": "",
            "verification_token": "",
            "offer_id_macro": "oid",
            "affiliate_id_macro": "affid",
            "time_created": 1582295424,
            "time_saved": 1582295424,
            "attribution_method": "last_touch",
            "email_attribution_method": "last_affiliate_attribution",
            "attribution_priority": "click",
            "relationship": {
                "labels": {
                    "total": 0,
                    "entries": []
                },
                "account_manager": {
                    "first_name": "Bob",
                    "last_name": "Smith",
                    "email": "my.everflow@gmail.com",
                    "work_phone": "8734215936",
                    "cell_phone": "",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": ""
                },
                "integrations": {
                    "advertiser_demand_partner": null
                }
            }
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 1
    }
}

Find By ID

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
reporting	Includes reporting informations
labels	Includes a list of labels associated to the advertiser
demand_partner	Includes the Everxchange information associated to the advertiser
billing	Includes the billing information associated to the advertiser
integrations	Includes the billing information associated to the advertiser
api	Includes the advertiser’s API keys

GET /v1/networks/advertisers/:advertiserId

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/advertisers/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

 {
    "network_advertiser_id": 1,
    "network_id": 1,
    "name": "Google",
    "account_status": "active",
    "network_employee_id": 11,
    "internal_notes": "",
    "address_id": 0,
    "is_contact_address_enabled": false,
    "sales_manager_id": 17,
    "is_expose_publisher_reporting_data": null,
    "default_currency_id": "USD",
    "platform_name": "",
    "platform_url": "",
    "platform_username": "",
    "reporting_timezone_id": 67,
    "accounting_contact_email": "",
    "verification_token": "",
    "offer_id_macro": "oid",
    "affiliate_id_macro": "affid",
    "attribution_method": "last_touch",
    "email_attribution_method": "last_affiliate_attribution",
    "attribution_priority": "click",
    "time_created": 1559919745,
    "time_saved": 1559919745,
    "relationship": {
        "labels": {
            "total": 0,
            "entries": []
        },
        "account_manager": {
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "my.everflow@gmail.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "reporting": {
            "imp": 0,
            "total_click": 0,
            "unique_click": 0,
            "invalid_click": 0,
            "duplicate_click": 0,
            "gross_click": 0,
            "ctr": 0,
            "cv": 0,
            "invalid_cv_scrub": 0,
            "view_through_cv": 0,
            "total_cv": 0,
            "event": 0,
            "cvr": 0,
            "evr": 0,
            "cpc": 0,
            "cpm": 0,
            "cpa": 0,
            "epc": 0,
            "rpc": 0,
            "rpa": 0,
            "rpm": 0,
            "payout": 0,
            "revenue": 0,
            "event_revenue": 0,
            "gross_sales": 0,
            "profit": 0,
            "margin": 0,
            "roas": 0,
            "avg_sale_value": 0,
            "media_buying_cost": 0
        },
        "api_keys": {
            "total": 0,
            "entries": []
        },
        "api_whitelist_ips": {
            "total": 0,
            "entries": []
        },
        "billing": {
            "network_id": 63,
            "network_advertiser_id": 13,
            "billing_frequency": "other",
            "invoice_amount_threshold": 0,
            "tax_id": "",
            "is_invoice_creation_auto": false,
            "auto_invoice_start_date": "2019-06-01 00:00:00",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 0,
            "default_payment_terms": 0,
            "relationship": {}
        },
        "settings": {
            "network_id": 63,
            "network_advertiser_id": 13,
            "exposed_variables": {
                "affiliate_id": false,
                "affiliate": false,
                "sub1": false,
                "sub2": false,
                "sub3": false,
                "sub4": false,
                "sub5": false,
                "source_id": false
            },
            "time_saved": 0
        },
        "sale_manager": {
         "first_name":" Bob",
         "last_name": "Smith",
         "email": "my.everflow@gmail.com",
         "work_phone": "4878866676",
         "cell_phone": "",
         "instant_messaging_id": 0,
         "instant_messaging_identifier": ""
      }
    }
}

Find (Advanced)

POST /v1/networks/advertiserstable

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

This endpoint supports accept query filters.

search_terms object array

View Object Details Hide Object Details

search_type string

The name of the field used for search. Only name is supported.

value string

The value to search.

filters object

View Object Details Hide Object Details

account_status string

Filter advertisers based on a specific account status. Supported values are: active, inactive and suspended.

account_manager_ids int array

Only include advertisers managed by the specified account managers.

labels string array

Only include advertisers matching the specified labels.

business_unit_ids int array

Filter advertisers based on the specified business units.

sales_manager_ids int array

Only include advertisers managed by the specified sales managers.

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/advertiserstable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Response

{
    "advertisers": [
        {
            "network_advertiser_id": 1,
            "network_id": 5,
            "name": "Some Brand Inc.",
            "account_status": "active",
            "account_manager_id": 266,
            "account_manager_name": "John Doe",
            "sales_manager_id": 0,
            "sales_manager_name": "",
            "today_revenue": "$101.50",
            "time_created": 1727118893,
            "time_saved": 1727118893,
            "labels": [
                "DTC brand"
            ],
            "verification_token": ""
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 1
    }
}

Create

POST /v1/networks/advertisers

Body Params

name string

The name of the advertiser.

account_status string

Status of the advertiser. Can be one of the following values: active , inactive, or suspended.

network_employee_id int

The employee id of the advertiser’s account manager.

internal_notes string

Internal notes for the advertiser.

address_id int

The address id of the advertiser.

is_contact_address_enabled boolean

Whether or not you want to include a contact address for this advertiser. Defaults to false.

sales_manager_id int

The employee id of the advertiser’s sales manager.

default_currency_id string

The advertiser’s default currency. Can be found using the metadata API.

platform_name string

The name of the shopping cart or attribution platform that your advertiser uses.

platform_url string

The URL for logging into your advertiser’s platform.

platform_username string

The user name details for logging into your advertiser’s platform.

reporting_timezone_id int

The timezone used in your advertiser’s platform reporting.

attribution_method string

Determines how attribution works for this advertiser. Can be last_touch or first_touch

email_attribution_method string

Determines how email attribution works for this advertiser. Can be last_affiliate_attribution or first_affiliate_attribution

attribution_priority string

Determines whether coupon code attribution should be prioritized over click attribution for this advertiser (the default is click). Can be click or coupon_code

accounting_contact_email string

The email address of the accounting contact.

verification_token string

If enabled, the verification token will be applied to all incoming postbacks for that advertiser. If the verification_token field doesn’t match the token, the conversions will be set to rejected. We support up to 50 characters for the token.

offer_id_macro string

The string used for the offer id macro. This determines your preferred link format for receiving the Offer ID when using a Direct Linking Setup. Leaving this field blank will fallback to oid.

affiliate_id_macro string

The string used for the affiliate id macro. This determines your preferred link format for receiving the Partner’s ID when using a Direct Linking Setup. Leaving this field blank will fallback to affid.

labels string array

The list of labels associated with the advertiser.

users object array

A list of at most one advertiser user to be created along with the advertiser entity.

View Object Details Hide Object Details

first_name string

The advertiser user’s first name

last_name string

The advertiser user’s last name

email string

The advertiser user’s email. Must be unique among all advertiser users. Is used to log in the platform.

account_status string

The advertiser user’s account status. Can be either active or inactive.

title string

The advertiser user’s title.

work_phone string

The advertiser user’s work phone number.

cell_phone string

The advertiser user’s cell phone number.

instant_messaging_id int

The id of an instant messaging platform. Allows you to save their identifier for further reference.

instant_messaging_identifier string

The advertiser user’s instant messaging identifier, if instant_messaging_id was different than 0.

language_id int

The advertiser user’s language id. This is limited to the value 1 (English).

timezone_id int

The advertiser user’s timezone id. Can be found using the metadata API.

currency_id string

The advertiser user’s currency id. Can be found using the metadata API

initial_password string

The advertiser user’s login password. If left empty, the advertiser will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters.

contact_address object

The advertiser’s contact address information. Only required if is_contact_address_enabled” is set to true.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

billing object

The advertiser’s billing information.

View Object Details Hide Object Details

billing_frequency string

The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.

invoice_amount_threshold double

Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to 0, which is none.

tax_id string

The advertiser’s tax id.

is_invoice_creation_auto boolean

Configures automatic invoice creations for the advertiser. Defaults to false.

auto_invoice_start_date string

Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.

default_invoice_is_hidden boolean

Configures whether invoices are hidden from the advertiser by default. Defaults to false.

invoice_generation_days_delay boolean

Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.

default_payment_terms int

Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.

details object

The advertiser’s billing frequency details. Required when billing_frequency is set to anything else than manual or other.

View Object Details Hide Object Details

day_of_week int

Specifies the day of the week, starting on. Required when “billing_frequency” is set to weekly.

day_of_month_one int

Specifies first the day of the month. Required when billing_frequency is set to bimonthly.

day_of_month_two int

Specifies second the day of the month. Required when billing_frequency is set to bimonthly.

day_of_month int

Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.

starting_month int

Specifies the month from which the cycle is set to begin. Required when billing_frequency is set to two_months or quarterly.

settings object

Variables exposed in the Advertiser UI.

View Object Details Hide Object Details

exposed_variables object

View Object Details Hide Object Details

affiliate_id boolean

Whether or not you want to expose the affiliate id variable in the advertiser UI.

affiliate boolean

Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.

sub1 boolean

Whether or not you want to expose the Sub1 variable in the advertiser UI.

sub2 boolean

Whether or not you want to expose the Sub2 variable in the advertiser UI.

sub3 boolean

Whether or not you want to expose the Sub3 variable in the advertiser UI.

sub4 boolean

Whether or not you want to expose the Sub4 variable in the advertiser UI.

sub5 boolean

Whether or not you want to expose the Sub5 variable in the advertiser UI.

source_id boolean

Whether or not you want to expose the Source ID variable in the advertiser UI.

Payload Example

{
  "name": "Some Brand Inc.",
  "account_status": "active",
  "network_employee_id": 264,
  "default_currency_id": "USD",
  "sales_manager_id": 227,
  "reporting_timezone_id": 80,
  "attribution_method": "last_touch",
  "email_attribution_method": "last_affiliate_attribution",
  "attribution_priority": "click",
  "verification_token": "c7HIWpFUGnyQfN5wwBollBBGtUkeOm",
  "internal_notes": "Some notes not visible to the advertiser",
  "is_contact_address_enabled": true,
  "contact_address":
  {
    "address_1": "4110 rue St-Laurent",
    "address_2": "202",
    "city": "Montreal",
    "zip_postal_code": "H2R 0A1",
    "country_id": 36,
    "country_code": "CA",
    "region_code": "QC"
  },
  "labels":
  [
    "DTC Brand"
  ],
  "users":
  [
    {
      "account_status": "active",
      "language_id": 1,
      "timezone_id": 80,
      "currency_id": "USD",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "initial_password": ""
    }
  ],
  "billing":
  {
    "details": {},
    "default_payment_terms": 0,
    "billing_frequency": "other",
    "tax_id": "123456789"
  },
  "settings":
  {
    "exposed_variables":
    {
      "affiliate_id": true,
      "affiliate": false,
      "sub1": true,
      "sub2": true,
      "sub3": false,
      "sub4": false,
      "sub5": false,
      "source_id": false,
      "offer_url": false
    }
  }
}

Update

PUT /v1/networks/advertisers/:advertiserId

You must specify all the fields, not only the ones you wish to update. Omitting a field that is not marked as required will result in its default value being used or in the field getting deleted entirely.

The Bulk Edit endpoint documented below allows you to update only certain fields on an advertiser, which is much less error prone.

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser you want to update

Body Params

name string

The name of the advertiser.

account_status string

Status of the advertiser. Can be one of the following values: active , inactive or suspended.

network_employee_id int

The employee id of the advertiser’s account manager.

internal_notes string

Internal notes for the advertiser.

address_id int

The address id of the advertiser.

is_contact_address_enabled boolean

Whether or not you want to include a contact address for this advertiser. Defaults to false.

sales_manager_id int

The employee id of the advertiser’s sales manager.

default_currency_id string

The advertiser’s default currency. Can be found using the metadata API.

platform_name string

The name of the shopping cart or attribution platform that your advertiser uses.

platform_url string

The URL for logging into your advertiser’s platform.

platform_username string

The user name details for logging into your advertiser’s platform.

reporting_timezone_id int

The timezone used in your advertiser’s platform reporting.

attribution_method string

Determines how attribution works for this advertiser. Can be last_touch or first_touch

email_attribution_method string

Determines how email attribution works for this advertiser. Can be last_affiliate_attribution or first_affiliate_attribution

attribution_priority string

Determines whether coupon code attribution should be prioritized over click attribution for this advertiser (the default is click). Can be click or coupon_code

accounting_contact_email string

The email address of the accounting contact.

verification_token string

offer_id_macro string

The string used for the offer id macro. This determines your preferred link format for receiving the Offer ID when using a Direct Linking Setup. Leaving this field blank will fallback to oid.

affiliate_id_macro string

labels string array

The list of labels associated with the advertiser.

contact_address object

The advertiser’s contact address information. Only required if is_contact_address_enabled is set to true.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

billing object

The advertiser’s billing information.

View Object Details Hide Object Details

billing_frequency string

The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.

invoice_amount_threshold double

Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to 0, which is none.

tax_id string

The advertiser’s tax id.

is_invoice_creation_auto boolean

Configures automatic invoice creations for the advertiser. Defaults to false.

auto_invoice_start_date string

Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.

default_invoice_is_hidden boolean

Configures whether invoices are hidden from the advertiser by default. Defaults to false.

invoice_generation_days_delay boolean

Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.

default_payment_terms int

Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.

details object

The advertiser’s billing frequency details. Required when billing_frequency is set to anything else than manual or other.

View Object Details Hide Object Details

day_of_week int

Specifies the day of the week, starting on. Required when billing_frequency is set to weekly.

day_of_month_one int

Specifies first the day of the month. Required when billing_frequency is set to bimonthly.

day_of_month_two int

Specifies second the day of the month. Required when billing_frequency is set to bimonthly.

day_of_month int

Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.

starting_month int

Specifies the month from which the cycle is set to begin. Required when billing_frequency is set to two_months or quarterly.

settings object

Variables exposed in the Advertiser UI.

View Object Details Hide Object Details

exposed_variables object

View Object Details Hide Object Details

affiliate_id boolean

Whether or not you want to expose the affiliate id variable in the advertiser UI.

affiliate boolean

Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.

sub1 boolean

Whether or not you want to expose the Sub1 variable in the advertiser UI.

sub2 boolean

Whether or not you want to expose the Sub2 variable in the advertiser UI.

sub3 boolean

Whether or not you want to expose the Sub3 variable in the advertiser UI.

sub4 boolean

Whether or not you want to expose the Sub4 variable in the advertiser UI.

sub5 boolean

Whether or not you want to expose the Sub5 variable in the advertiser UI.

source_id boolean

Whether or not you want to expose the Source ID variable in the advertiser UI.

Payload Example

{
  "network_advertiser_id": 289,
  "network_id": 5,
  "name": "Some Brand Inc.",
  "account_status": "active",
  "network_employee_id": 264,
  "internal_notes": "Some Internal Notes",
  "sales_manager_id": 227,
  "is_expose_publisher_reporting_data": null,
  "default_currency_id": "USD",
  "platform_name": "",
  "platform_url": "",
  "platform_username": "",
  "reporting_timezone_id": 80,
  "accounting_contact_email": "",
  "verification_token": "c7HIWpFUGnyQfN5wwBollBBGtUkeOm",
  "offer_id_macro": "oid",
  "affiliate_id_macro": "affid",
  "time_created": 1727214292,
  "time_saved": 1727214610,
  "attribution_method": "last_touch",
  "email_attribution_method": "last_affiliate_attribution",
  "attribution_priority": "coupon_code",
  "is_contact_address_enabled": true,
  "address_id": 84636,
  "contact_address": {
    "address_1": "4110 rue St-Laurent",
    "address_2": "202",
    "city": "Montreal",
    "zip_postal_code": "H2R 0A1",
    "country_id": 36,
    "country_code": "CA",
    "region_code": "QC"
  },
  "labels": [
    "DTC Brand"
  ],
  "users": [],
  "billing": {
    "network_id": 5,
    "network_advertiser_id": 289,
    "billing_frequency": "other",
    "invoice_amount_threshold": 0,
    "tax_id": "123456789",
    "is_invoice_creation_auto": false,
    "auto_invoice_start_date": "2019-06-01 00:00:00",
    "default_invoice_is_hidden": false,
    "invoice_generation_days_delay": 0,
    "default_payment_terms": 0
  },
  "settings":
  {
    "exposed_variables":
    {
      "affiliate_id": true,
      "affiliate": false,
      "sub1": true,
      "sub2": true,
      "sub3": false,
      "sub4": false,
      "sub5": false,
      "source_id": false,
      "offer_url": false
    }
  }
}

Bulk Edit

PATCH /v1/networks/patch/advertiser/apply

This endpoint allows you to update selected fields of one or multiple advertisers at the same time. It does not require the entire advertiser object to be passed in the payload. Only the properties that need to be changed must be supplied.

Request Body

Body Param

network_advertiser_ids int array

IDs of the advertisers to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the advertisers. Can be one of the following values: overwrite, append, delete, or clear. Not all options are possible for every field. append, delete and clear only apply for fields that contain multiple values.

Body Example

{
    "network_advertiser_ids": [
        3,
        12
    ],
    "fields": [
        {
            "field_type": "advertiser_status",
            "field_value": "inactive",
            "operator": "overwrite"
        }
    ]
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/patch/advertiser/apply' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Deactivate multiple advertisers at the same time :

{
    "network_advertiser_ids": [
        3,
        12
    ],
    "fields": [
        {
            "field_type": "advertiser_status",
            "field_value": "inactive",
            "operator": "overwrite"
        }
    ]
}

Example 2 : Update the verification token of a single advertiser

{
    "network_advertiser_ids": [
        8
    ],
    "fields": [
        {
            "field_type": "verification_token",
            "field_value": "4nhNQCpvOEGfrngJUhj73fKbAuujov",
            "operator": "overwrite"
        }
    ]
}

Response

{
  "result": true
}

Patch Preview

POST /v1/networks/patch/advertiser/submit

This endpoint works exactly the same way the Bulk Edit endpoint documented above does, with the important difference that it does not actually change anything. Rather the endpoint will return of a preview of the changes and will flag any errors.

Body Params

network_advertiser_ids int array

IDs of the advertisers to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the advertisers. Can be one of the following values: overwrite, append, delete, or clear.

Response

changes object array

View Object Details Hide Object Details

network_advertiser object

An advertiser part of the patch submission.

View Object Details Hide Object Details

network_advertiser_id int

ID of the advertiser.

name string

Name of the advertiser.

change_status string

Status of the change. Can be one of the following values: ok, no_change or error.

current_field object

View Object Details Hide Object Details

field_type string

Type of the field before the patch. See here for the list of types.

field_value

Value of the field before the patch. See here for the list of values.

changed_field object

View Object Details Hide Object Details

field_type string

Type of the field after the patch. See here for the list of types.

field_value

Value of the field after the patch. See here for the list of values.

error_message string

Error message for that particular field. Only filled when change_status is error.

related_changes string

Message detailing other changes that will happen as a consequence of the particular change.

resource_errors object array

If some of the advertisers that are part of the patch are not in a valid state prior to the patch, the patch will not be attempted and instead a list of the advertiser errors will be returned here.

View Object Details Hide Object Details

id int

ID of the invalid advertiser.

label string

Name of the invalid advertiser.

message string

Message indicating in which way the advertiser is invalid.

Patchable Fields

The fields below are to be used in the Bulk Edit and Patch Preview endpoints documented above.

Fields

advertiser_status string

Status of the advertiser. Can be one of the following values: active, inactive or suspended.

account_manager_id int

The employee ID of the advertiser’s account manager.

sales_manager_id int

The employee ID of the advertiser’s sales manager.

labels string array

The list of labels associated with the advertiser.

advertiser_name string

The name of the advertiser

currency_id string

The advertiser’s default currency. Can be found using the metadata API.

attribution_method string

Can be one of the following values: first_touch or last_touch.

attribution_priority string

Determines whether click attribution takes precedence over coupon code attribution for these advertisers. Can be one of the following values: click or coupon_code.

email_attribution_method string

Can be one of the following values: first_affiliate_attribution or last_affiliate_attribution.

internal_note string

Internal notes for the advertiser.

verification_token string

variables_affiliate_id boolean

Whether or not you want to expose the affiliate ID in the advertiser UI.

variables_affiliate boolean

Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.

variables_sub1 boolean

Whether or not you want to expose the Sub1 variable in the advertiser UI.

variables_sub2 boolean

Whether or not you want to expose the Sub2 variable in the advertiser UI.

variables_sub3 boolean

Whether or not you want to expose the Sub3 variable in the advertiser UI.

variables_sub4 boolean

Whether or not you want to expose the Sub4 variable in the advertiser UI.

variables_sub5 boolean

Whether or not you want to expose the Sub5 variable in the advertiser UI.

variables_source_id boolean

Whether or not you want to expose the Source ID variable in the advertiser UI.

billing_tax_details string

The advertiser’s tax id.

billing_frequency string

The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.

billing_frequency_weekly object

The advertiser’s billing weekly frequency details. Required when billing_frequency is set to weekly.

View Object Details Hide Object Details

day_of_week int

Specifies the day of the week, starting on. Required when “billing_frequency” is set to weekly.

billing_frequency_bimonthly object

The advertiser’s billing bimonthly frequency details. Required when billing_frequency is set to bimonthly.

View Object Details Hide Object Details

day_of_month_one int

Specifies first the day of the month. Required when billing_frequency is set to bimonthly.

day_of_month_two int

Specifies second the day of the month. Required when billing_frequency is set to bimonthly.

billing_frequency_monthly object

The advertiser’s billing monthly frequency details. Required when billing_frequency is set to monthly.

View Object Details Hide Object Details

day_of_month int

Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.

billing_frequency_two_months object

The advertiser’s billing two months frequency details. Required when billing_frequency is set to two_months.

View Object Details Hide Object Details

day_of_month int

Specifies day of the month.

starting_month int

Specifies the month from which the cycle is set to begin.

billing_frequency_quarterly object

The advertiser’s billing quarterly frequency details. Required when billing_frequency is set to quarterly.

View Object Details Hide Object Details

day_of_month int

Specifies day of the month.

starting_month int

Specifies the month from which the cycle is set to begin.

billing_auto_invoicing_auto_creation boolean

Configures automatic invoice creations for the advertiser. Defaults to false.

billing_auto_invoicing_creation_amount_threshold double

Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to 0, which is none.

billing_auto_invoicing_auto_invoice_start_date string

Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.

billing_auto_invoicing_generation_days_delay int

Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.

billing_invoice_setting_terms_days int

Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.

billing_invoice_setting_hide_from_advertiser_ boolean

Configures whether invoices are hidden from the advertiser by default. Defaults to false.

offer_id_macro string

The string used for the offer id macro. This determines your preferred link format for receiving the Offer ID when using a Direct Linking Setup. Leaving this field blank will fallback to oid.

affiliate_id_macro string

Docs: Advertiser Users

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/advertisers/:advertiserId/users

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser whose users you want to fetch

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
logins	Includes the user’s list of logins
password_history	Includes the user’s password changes history
api	Includes the user’s API key and whitelisted IPs
customizations	Includes the user’s customizations

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/advertisers/1/users' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "users": [
        {
            "network_advertiser_user_id": 17,
            "network_id": 1,
            "network_advertiser_id": 1,
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "my.everflow@gmail.com",
            "title": "",
            "work_phone": "9655433513",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": "",
            "language_id": 1,
            "timezone_id": 75,
            "currency_id": "USD",
            "account_status": "active"
        }
    ]
}

Find By ID

GET /v1/networks/advertisers/:advertiserId/users/:userId

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser whose user you want to fetch
userId	The ID of the user you want to fetch

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
logins	Includes the user’s list of logins
password_history	Includes the user’s password changes history
api	Includes the user’s API key and whitelisted IPs
customizations	Includes the user’s customizations

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/advertisers/1/users/17' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "network_advertiser_user_id": 17,
    "network_id": 1,
    "network_advertiser_id": 13,
    "first_name": "Bob",
    "last_name": "Smitch",
    "email": "my.everflow@gmail.com",
    "title": "",
    "work_phone": "9655433513",
    "cell_phone": "",
    "instant_messaging_id": 0,
    "instant_messaging_identifier": "",
    "language_id": 1,
    "timezone_id": 75,
    "currency_id": "USD",
    "account_status": "active"
}

Create

POST /v1/networks/advertisers/:advertiserId/users

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser for whom to create a user

Body Params

first_name string

The advertiser user’s first name

last_name string

The advertiser user’s last name

email string

The advertiser user’s email. Must be unique among all advertiser users. Used to log in the platform.

title string

The advertiser user’s title.

work_phone string

The advertiser user’s work phone number.

cell_phone string

The advertiser user’s cell phone number.

instant_messaging_id int

The ID of an instant messaging platform. Allows you to save their identifier for further reference. Values are 0 for None, 1 for Skype, 2 for Yahoo Messenger.

instant_messaging_identifier string

The advertiser user’s instant messaging identifier, if instant_messaging_id was different than 0.

language_id int

The advertiser user’s language ID. This is limited to the value 1 (English).

timezone_id int

The advertiser user’s timezone ID. Can be found using the metadata API.

currency_id string

The advertiser user’s currency ID. Can be found using the metadata API.

account_status string

The advertiser user’s account status. Can be either active or inactive.

initial_password string

The advertiser user’s login password. If left empty, the advertiser will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters.

Payload Example

{
    "currency_id": "USD",
    "instant_messaging_id": 0,
    "account_status": "active",
    "language_id": 1,
    "timezone_id": 90,
    "initial_password": "",
    "first_name": "Bob",
    "last_name": "Smith",
    "title": "Manager",
    "work_phone": "1234567788",
    "email": "my.everflow@gmail.com"
}

Update

PUT /v1/networks/advertisers/:advertiserId/users/:userId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
advertiserId	The ID of the advertiser whose user you want to update
userId	The ID of the user you want to update

Body Params

first_name string

The advertiser user’s first name

last_name string

The advertiser user’s last name

email string

The advertiser user’s email. Must be unique among all advertiser users. Is used to log in the platform.

title string

The advertiser user’s title.

work_phone string

The advertiser user’s work phone number.

cell_phone string

The advertiser user’s cell phone number.

instant_messaging_id int

The id of an instant messaging platform. Allows you to save their identifier for further reference.

instant_messaging_identifier string

The advertiser user’s instant messaging identifier, if instant_messaging_id was different than 0.

language_id int

The advertiser user’s language id. This is limited to the value 1 (English).

timezone_id int

The advertiser user’s timezone id. Can be found using the metadata API.

currency_id string

The advertiser user’s currency id. Can be found using the metadata API (insert link)

account_status string

The advertiser user’s account status. Can be either active or inactive.

initial_password string

The advertiser user’s login password.

Payload Example

{
    "currency_id": "USD",
    "instant_messaging_id": 0,
    "account_status": "active",
    "language_id": 1,
    "timezone_id": 90,
    "initial_password": "",
    "first_name": "Bob",
    "last_name": "Smith",
    "title": "Manager",
    "work_phone": "1234567788",
    "email": "my.everflow@gmail.com"
}

Docs: Affiliates

Mon, 01 Jan 0001 00:00:00 +0000

Fetch Affiliates

POST /v1/networks/affiliatestable

This is the main endpoint to extract a list of affiliates from the API. It’s possible to filter the affiliates returned by this endpoint using 2 different methods (which can be combined) :

Search Terms : equivalent to a text search (e.g. find affiliates with a name that contains the word “John”)
Query Filters : structured filters on predefined fields (e.g. find affiliates that are managed by Affiliate Manager John Doe)

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

This endpoint supports query filters.

search_terms object array

View Object Details Hide Object Details

search_type string

The name of the field used for search. Only “name” is supported.

value string

The value to search.

filters object

View Object Details Hide Object Details

account_status string

Filter affiliates based on a specific account status. Supported values are: “active”, “inactive”, “pending” and “suspended”.

account_manager_ids int array

Only include affiliates managed by the specified account managers.

network_account_executives_ids int array

Only include affiliates managed by the specified account executives.

billing_frequency string

Filter affiliates based on a specific billing frequency. Supported values are: “weekly”, “bimonthly”, “monthly”, “two_months”, “quarterly”, “manual” and “other”.

payment_type string

Filter affiliates based on a specific payment type. Supported values are: “none”, “pay”, “paypal”, “check”, “wire”, “direct_deposit”, “tipalti”, “paxum”, “veem”, “payoneer”, “bitcoin”, “webmoney”, “capitalist”, “transferwise”, “gift_card”, “masspay” and “skrill”.

labels string array

Only include affiliates matching the specified labels.

ran_traffic_in_last_hours int

Only include affiliates that ran traffic in the last amount of hours specified.

network_tracking_domain_ids int array

Only include affiliates running traffic on the specified tracking domains.

country_codes string array

Only include affiliates who’s address is in one of the countries specified

region_codes string array

Only include affiliates who’s address is in one of the regions specified. Note that region codes are not always globally unique so this filter is best used along with the country_codes filter.

Relationships

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

Value	Description
signup	Includes the affiliate’s sign up information
users	Includes the users that exist for the affiliate

Examples

The following examples are different variations of what you can pass as a payload in the following call :

cURL

curl --request POST 'https://api.eflow.team/v1/networks/affiliatestable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch the active affiliates

{
  "filters": {
    "account_status": "active"
  }
}

To fetch, for example, the second page of 50 active affiliates and include their users, you would run the following call :

curl --request POST 'https://api.eflow.team/v1/networks/affiliatestable?page=2&page_size=50&relationship=users' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "account_status": "active"
  },
}'

Example 2 : Fetch affiliates managed by affiliate manager with ID 2 that contain the word “Agency”

{
  "filters": {
    "account_manager_ids": [ 2 ]
  },
  "search_terms": [
    {
      "search_type": "name",
      "value": "Agency"
    }
  ]
}

Example 3 : Fetch active affiliates that have run traffic in the last 7 days :

{
  "filters": {
    "account_status": "active",
    "ran_traffic_in_last_hours": 168
  }
}

Response

{ "affiliates": [ { "network_affiliate_id": 7, "network_id": 1, "name": "Some Agency Inc.", "account_status": "active", "account_manager_id": 1, "account_manager_name": "John Doe", "account_executive_id": 0, "account_executive_name": "", "today_revenue": "$7.32", "time_created": 1664825245, "time_saved": 1664825245, "labels": [ "media_buyer" ], "balance": 0, "last_login": 1664985191, "global_tracking_domain_url": "", "network_country_code": "", "is_payable": false, "payment_type": "none" } ], "paging": { "page": 1, "page_size": 50, "total_count": 1 } }

Find By ID

GET /v1/networks/affiliates/:affiliateId

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
reporting	Includes reporting informations
billing	Includes billing and invoicing informations
coupon_codes	Includes a list of the affiliate’s coupon codes
users	Includes the list of affiliate users
audits	Includes the revision history of changes made to the affiliate
visibility	Includes lists of visible, hidden and rejected offers
signup	Includes the affiliate’s signup info
api	Includes the affiliate’s API keys
traffic_source	Includes the affiliate’s traffic sources
referral_link	Includes the affiliate’s referral link
referrer	Include the affiliate’s referer, if any
referral	Includes the affiliate’s referral info
supply_partner	Includes the affiliate’s EverXchange settings

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

 {
    "network_affiliate_id": 1,
    "network_id": 346,
    "name": "Google",
    "account_status": "active",
    "network_employee_id": 6,
    "internal_notes": "",
    "has_notifications": true,
    "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": 1554517251,
    "time_saved": 1560453624,
    "relationship": {
        "labels": {
            "total": 1,
            "entries": [
                "Direct"
            ]
        },
        "account_manager": {
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "my.everflow@gmail.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 1,
            "instant_messaging_identifier": "peter_mobaff"
        },
        "encoded_value": "28KL6"
    },
    "referrer_id": 0
}

Create

POST /v1/networks/affiliates

Body Params

name string

The name of the affiliate

account_status string

The affiliate’s account status. Can either be active or inactive.

network_employee_id int

The employee id of the affiliate’s account manager.

internal_notes int

Internal notes for network usage

default_currency_id string

The affiliate’s default currency. Can be found using the metadata API

enable_media_cost_tracking_links boolean

Whether or not you want to allow affiliate to pass and override cost in their tracking links. Defaults to false.

referrer_id int

The id of the affiliate that referred the new affiliate. Defaults to 0 (none).

is_contact_address_enabled boolean

Whether or not you want to include a contact address for this affiliate. Defaults to false.

network_affiliate_tier_id int

The ID of the Affiliate Tier.

contact_address object

The affiliate’s contact address information. Only required if “is_contact_address_enabled” is set to true.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

labels string array

Used to associate labels to affiliate.

users object array

A list of affiliate users to be created along with the affiliate entity.

View Object Details Hide Object Details

first_name string

The affiliate user’s first name

last_name string

The affiliate user’s last name

email string

The affiliate user’s email. Must be unique among all affiliate users. Is used to log in the platform.

account_status string

The affiliate user’s account status. Can be either active or inactive.

title string

The affiliate user’s title.

work_phone string

The affiliate user’s work phone number.

cell_phone string

The affiliate user’s cell phone number.

instant_messaging_id int

The id of an instant messaging platform. Allows you to save their identifier for further reference.

instant_messaging_identifier string

The affiliate user’s instant messaging identifier, if instant_messaging_id was different than 0.

language_id int

The affiliate user’s language id. This is limited to the value 1 (English).

timezone_id int

The affiliate user’s timezone id. Can be found using the metadata API.

currency_id string

The affiliate user’s currency id. Can be found using the metadata API

initial_password string

The affiliate user’s login password. If left empty, the affiliate will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters.

billing object

The affiliate’s billing information.

View Object Details Hide Object Details

billing_frequency string

The affiliate’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.

payment_type string

The affiliate’s payment type. Can be one of the following values: none, pay (this is Everflow Pay), paypal, check, wire, direct_deposit, tipalti, payum, veem, payoneer, bitcoin, webmoney, capitalist, transferwise, gift_card, masspay or skrill

tax_id string

The affiliate’s tax id.

is_invoice_creation_auto boolean

Configures automatic invoice creations for the affiliate. Defaults to “false”.

auto_invoice_start_date string

Configures automatic invoice creation start date. Dates are formatted “YYYY-mm-dd”. Required if is_invoice_creation_auto is set to true.

default_invoice_is_hidden boolean

Configures whether invoices are hidden from the affiliate by default. Defaults to “false”.

invoice_generation_days_delay boolean

Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.

invoice_amount_threshold double

Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to 0.

default_payment_terms int

Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.

details object

The affiliate’s billing frequency details. Required when “billing_frequency” is set to anything else than “manual” or “other” or when payment_type is not ‘none’ (an empty object is required)

View Object Details Hide Object Details

day_of_week int

Specifies the day of the week, starting on. Required when “billing_frequency” is set to “weekly”.

day_of_month_one int

Specifies first the day of the month. Required when “billing_frequency” is set to “bimonthly”.

day_of_month_two int

Specifies second the day of the month. Required when “billing_frequency” is set to “bimonthly”.

day_of_month int

Specifies day of the month. Required when “billing_frequency” is set to “monthly”, “two_months” or “quarterly”.

starting_month int

Specifies the month from which the cycle is set to begin. Required when “billing_frequency” is set to “two_months” or “quarterly”.

billing object

The affiliate’s payment method details. When “payment_type” is set to “none” an empty object should be applied.

View Object Details Hide Object Details

paxum_id string

The affiliate’s paxum id. Required when “payment_type” is set to “paxum”.

paypal_reception_method string

The reception method used with Paypal. Can be either “email”, “phone” or “paypal_account”. Required when “payment_type” is set to “paypal”.

reception_identifier string

The affiliate’s paypal reception identifier. Required when “payment_type” is set to “paypal”.

email string

The affiliate’s email. Required when “payment_type” is set to “payoneer” or “veem”.

is_existing_payee boolean

Whether you want to assign an existing payee id to this affiliate. Required when “payment_type” is set to “tipalti”.

idap string

The payee’s IDAP (Payee ID). Required when “payment_type” is set to “tipalti” and is_existing_payee is set to true.

first_name string

The affiliate’s first name. Required when “payment_type” is set to “veem”.

last_name string

The affiliate’s last name. Required when “payment_type” is set to “veem”.

phone string

The affiliate’s phone number, must be international format. Required when “payment_type” is set to “veem”.

country_iso string

The affiliate’s country ISO code. Required when “payment_type” is set to “veem”.

bank_name string

The affiliate’s bank name. Required when “payment_type” is set to “wire” or “direct_deposit”.

bank_address string

The affiliate’s bank address. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_name string

The affiliate’s bank account name. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_number string

The affiliate’s bank account number. Required when “payment_type” is set to “wire” or “direct_deposit”.

routing_number string

The affiliate’s bank routing number. Required when “payment_type” is set to “wire” or “direct_deposit”.

swift_code string

The affiliate’s swift code. Required when “payment_type” is set to “wire” or “direct_deposit”.

Payload Example

E.g. payment method is none and billing frequency is selected

{   
    "name": "Test Affiliate",
    "account_status": "active",
    "network_employee_id": 1,
    "internal_notes": "This is a test affiliate created using the API",
    "default_currency_id": "USD",
    "enable_media_cost_tracking_links": false,
    "referrer_id": 0,
    "is_contact_address_enabled": true,
    "contact_address": {
        "address_1": "105 Ocean Avenue",
        "address_2": "",
        "city": "Los Angeles",
        "region_code": "CA",
        "country_code": "US",
        "zip_postal_code": "GHGHGH"
    },
    "labels":["test",
        "type 1"],
    "users": [
        {
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "everflow.test@example.com",
            "account_status": "active",
            "initial_password": "J0hnD0e2020!",
            "language_id": 1,
            "timezone_id": 90,
            "currency_id": "USD"
        }
    ],
    "billing": {
        "billing": {},
        "billing_frequency": "monthly",
        "payment_type": "none",
        "tax_id": "XXXXX",
        "details": {
            "day_of_month": 1
        }
    }
}

E.g. payment method is selected and billing frequency is none

{   
    "name": "Test Affiliate",
    "account_status": "active",
    "network_employee_id": 1,
    "internal_notes": "This is a test affiliate created using the API",
    "default_currency_id": "USD",
    "enable_media_cost_tracking_links": false,
    "referrer_id": 0,
    "is_contact_address_enabled": true,
    "contact_address": {
        "address_1": "105 Ocean Avenue",
        "address_2": "",
        "city": "Los Angeles",
        "region_code": "CA",
        "country_code": "US",
        "zip_postal_code": "GHGHGH"
    },
    "labels":["test",
        "type 1"],
    "users": [
        {
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "everflow.test@example.com",
            "account_status": "active",
            "initial_password": "J0hnD0e2020!",
            "language_id": 1,
            "timezone_id": 90,
            "currency_id": "USD"
        }
    ],
    "billing": {
        "billing": {},
        "billing_frequency": "none",
        "payment_type": "wire",
        "tax_id": "XXXXX",
        "details": {}
    }
}

Update

PUT /v1/networks/affiliates/:affiliateId

The Bulk Edit endpoint documented below allows you to update only certain fields on an affiliate, which is much less error prone.

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate you want to update

Body Params

name string

The name of the affiliate

account_status string

The affiliate’s account status. Can either be active or inactive.

network_employee_id int

The employee id of the affiliate’s account manager.

internal_notes string

Internal notes for network usage

default_currency_id string

The affiliate’s default currency. Can be found using the metadata API (insert link)

enable_media_cost_tracking_links boolean

Whether or not you want to allow affiliate to pass and override cost in their tracking links. Defaults to false.

referrer_id int

The id of the affiliate that referred the new affiliate. Defaults to 0 (none).

is_contact_address_enabled boolean

Whether or not you want to include a contact address for this affiliate. Defaults to false.

network_affiliate_tier_id int

The ID of the Affiliate Tier.

contact_address object

The affiliate’s contact address information. Only required if “is_contact_address_enabled” is set to true.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

labels string array

Used to associate labels to affiliate.

billing object

The affiliate’s billing information.

View Object Details Hide Object Details

billing_frequency string

The affiliate’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.

payment_type string

tax_id string

The affiliate’s tax id.

is_invoice_creation_auto boolean

Configures automatic invoice creations for the affiliate. Defaults to “false”.

auto_invoice_start_date string

Configures automatic invoice creation start date. Dates are formatted “YYYY-mm-dd”. Required if is_invoice_creation_auto is set to true.

default_invoice_is_hidden boolean

Configures whether invoices are hidden from the affiliate by default. Defaults to “false”.

invoice_generation_days_delay boolean

Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.

invoice_amount_threshold double

Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to 0, which is none.

default_payment_terms int

Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.

details object

View Object Details Hide Object Details

day_of_week int

Specifies the day of the week, starting on. Required when “billing_frequency” is set to “weekly”.

day_of_month_one int

Specifies first the day of the month. Required when “billing_frequency” is set to “bimonthly”.

day_of_month_two int

Specifies second the day of the month. Required when “billing_frequency” is set to “bimonthly”.

day_of_month int

Specifies day of the month. Required when “billing_frequency” is set to “monthly”, “two_months” or “quarterly”.

starting_month int

Specifies the month from which the cycle is set to begin. Required when “billing_frequency” is set to “two_months” or “quarterly”.

billing object

The affiliate’s payment method details. When “payment_type” is set to “none” an empty object should be applied.

View Object Details Hide Object Details

paxum_id string

The affiliate’s paxum id. Required when “payment_type” is set to “paxum”.

paypal_reception_method string

The reception method used with Paypal. Can be either “email”, “phone” or “paypal_account”. Required when “payment_type” is set to “paypal”.

reception_identifier string

The affiliate’s paypal reception identifier. Required when “payment_type” is set to “paypal”.

email string

The affiliate’s email. Required when “payment_type” is set to “payoneer” or “veem”.

is_existing_payee boolean

Whether you want to assign an existing payee id to this affiliate. Required when “payment_type” is set to “tipalti”.

idap string

The payee’s IDAP (Payee ID). Required when “payment_type” is set to “tipalti” and is_existing_payee is set to true.

first_name string

The affiliate’s first name. Required when “payment_type” is set to “veem”.

last_name string

The affiliate’s last name. Required when “payment_type” is set to “veem”.

phone string

The affiliate’s phone number, must be international format. Required when “payment_type” is set to “veem”.

country_iso string

The affiliate’s country ISO code. Required when “payment_type” is set to “veem”.

bank_name string

The affiliate’s bank name. Required when “payment_type” is set to “wire” or “direct_deposit”.

bank_address string

The affiliate’s bank address. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_name string

The affiliate’s bank account name. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_number string

The affiliate’s bank account number. Required when “payment_type” is set to “wire” or “direct_deposit”.

routing_number string

The affiliate’s bank routing number. Required when “payment_type” is set to “wire” or “direct_deposit”.

swift_code string

The affiliate’s swift code. Required when “payment_type” is set to “wire” or “direct_deposit”.

Payload Example

{   
    "name": "Test Affiliate",
    "account_status": "active",
    "network_employee_id": 1,
    "internal_notes": "This is a test affiliate created using the API",
    "default_currency_id": "USD",
    "enable_media_cost_tracking_links": false,
    "referrer_id": 0,
    "is_contact_address_enabled": true,
    "contact_address": {
        "address_1": "105 Ocean Avenue",
        "address_2": "",
        "city": "Los Angeles",
        "region_code": "CA",
        "country_code": "US",
        "zip_postal_code": "GHGHGH"
    },
    "labels":["test",
        "type 1"],
    "billing": {
        "billing": {},
        "billing_frequency": "monthly",
        "payment_type": "none",
        "tax_id": "XXXXX",
        "details": {
            "day_of_month": 1
        }
    }
}

Bulk Edit

PATCH /v1/networks/patch/affiliates/apply

This endpoint allows you to update selected fields of one or multiple affiliates at the same time. It does not require the entire affiliate object to be passed in the payload. Only the properties that need to be changed must be supplied.

Request Body

Body Param

network_affiliate_ids int array

IDs of the affiliates to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the affiliates. Can be one of the following values: overwrite, append, delete, or clear. Not all options are possible for every field. append, delete and clear only apply for fields that contain multiple values.

Body Example

{
    "network_affiliate_ids": [
        3,
        12
    ],
    "fields": [
        {
            "field_type": "account_status",
            "field_value": "inactive",
            "operator": "overwrite"
        }
    ]
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/patch/affiliates/apply' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Deactivate multiple affiliates at the same time :

{
    "network_affiliate_ids": [
        3,
        12
    ],
    "fields": [
        {
            "field_type": "account_status",
            "field_value": "inactive",
            "operator": "overwrite"
        }
    ]
}

Example 2 : Add a label (without removing existing labels) to existing affiliates

{
    "network_affiliate_ids":
    [
        24,
        26
    ],
    "fields":
    [
        {
            "field_value":
            [
                "New Label"
            ],
            "field_type": "labels",
            "operator": "append"
        }
    ]
}

Response

{
  "result": true
}

Patch Preview

POST /v1/networks/patch/affiliates/submit

This endpoint works exactly the same way the Bulk Edit endpoint documented above does, with the important difference that it does not actually change anything. Rather, the endpoint will return of a preview of the changes and will flag any errors.

Body Params

network_affiliate_ids int array

IDs of the affiliates to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the affiliates. Can be one of the following values: overwrite, append, delete, or clear.

Response

changes object array

View Object Details Hide Object Details

network_affiliate object

An affiliate part of the patch submission.

View Object Details Hide Object Details

network_affiliate_id int

ID of the affiliate.

name string

Name of the affiliate.

change_status string

Status of the change. Can be one of the following values: ok, no_change or error.

current_field object

View Object Details Hide Object Details

field_type string

Type of the field before the patch. See here for the list of types.

field_value

Value of the field before the patch. See here for the list of values.

changed_field object

View Object Details Hide Object Details

field_type string

Type of the field after the patch. See here for the list of types.

field_value

Value of the field after the patch. See here for the list of values.

error_message string

Error message for that particular field. Only filled when change_status is error.

related_changes string

Message detailing other changes that will happen as a consequence of the particular change.

resource_errors object array

If some of the affiliates that are part of the patch are not in a valid state prior to the patch, the patch will not be attempted and instead a list of the affiliates errors will be returned here.

View Object Details Hide Object Details

id int

ID of the invalid affiliate.

label string

Name of the invalid affiliate.

message string

Message indicating in which way the affiliate is invalid.

Patchable Fields

The fields below are to be used in the Bulk Edit and Patch Preview endpoints documented above.

Fields

network_employee_id int

The employee ID of the affiliate’s account manager.

account_executive_id int

The employee ID of the affiliate’s account executive.

referrer_id int

The affiliate ID of the affiliate’s account that referred the target affiliate(s).

labels string array

The list of labels associated with the affiliate.

affiliate_name string

The name of the affiliate

account_status string

Status of the affiliate. Can be one of the following values: active, inactive or suspended.

default_currency_id string

The affiliate’s default currency. Possible values can be found using the metadata API. Can be overwritten at the affiliate user level.

has_notifications boolean

Whether or not the affiliate can receive notifications.

enable_media_cost_tracking_links boolean

Determines whether the cost parameter will be processed or ignored when received on clicks.

network_traffic_source_id int

An optional tracking source ID that can be used for the affiliate.

internal_notes string

Internal notes are not visible

billing_payment_method string

The billing method used by the affiliate. Note that this field can only be used in conjunction with Everflow Pay, so the only possible value is pay. The account must be integrated with Everflow Pay in the first place.

billing_billing_frequency string

Affiliate billing frequency. Possible values are : weekly, bimonthly, monthly, two_months, quaterly, manual, other. Note that when setting the frequency, you must also set the rest of the frequency setting. For example, if you set the billing_billing_frequency to weekly, you must also set the billing_weekly property described below.

billing_weekly string

Only relevant when frequency is set to weekly. Possible values are monday, tuesday, wednesday, thursday, friday, saturday, sunday.

billing_bimonthly object

Only relevant when frequency is set to bimonthly.

View Object Details Hide Object Details

day_of_month_one int

Specifies first day of the month.

day_of_month_two int

Specifies second day of the month.

billing_monthly object

Only relevant when frequency is set to monthly.

View Object Details Hide Object Details

day_of_month int

Specifies day of the month.

billing_two_months object

Only relevant when frequency is set to two_months.

View Object Details Hide Object Details

starting_month int

First month of the 2 months interval

day_of_month int

Day of the month

billing_quarterly object

Only relevant when frequency is set to quaterly.

View Object Details Hide Object Details

starting_month int

First month of the quarter period

day_of_month int

Day of the month

billing_is_invoice_creation_auto boolean

Determines whether invoices are generated automatically or not.

billing_invoice_amount_threshold double

Minimum amount that must be reached before an invoice is generated.

billing_auto_invoice_start_date date

Only relevant when invoices are generated automatically. Date of the lookback window.

billing_invoice_generation_days_delay int

Number of days after the beginning of the billing period before the invoice is generated.

billing_default_payment_terms int

Number of days before the payment is sent

billing_default_invoice_is_hidden boolean

Determines whether invoices are hidden to affiliates or not by default.

referral_is_enabled boolean

Determines if referral commissions are enabled or not

referral_method string

Referral commission method. Possible values are flat_fee or percentage

referral_value double

Value of the referral commission

referral_commission_basis string

Determines if the commission is based on payout, revenue or profit.

referral_minimum_threshold double

Minimum amount that must be reached before a commission is paid.

referral_duration double

Number of days during which the referral commission is effective.

Pending Affiliates

PATCH /v1/networks/pending/affiliates

This endpoint is for changing the status of a pending affiliate to either a active or inactive/rejected state. Multiple pending affiliate’s status’s can be changed at once and not all parameters need to be present in the call be made.

Request Body

Body Param

network_affiliate_ids int array

IDs of the affiliates to be patched.

account_status

The status the affiliates will be updated to. Can be one of the following values: active, inactive or suspended.

affiliate_manager_id

The employee id of the affiliates account manager.

network_traffic_source_id

Traffic source if any that should be associated with the affiliates being activated

Body Example

{
    "network_affiliate_ids": [
        3,
        12
    ],
      "account_status": "active",
      "affiliate_manager_id": 1,
      "network_traffic_source_id": 0
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/pending/affiliates' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : rejecting/suspending multiple pending affiliates at the same time :

{
    "network_affiliate_ids": [
        3,
        12
    ],  
    "account_status": "inactive",
    "affiliate_manager_id": 1
}

Example 2 : approving a single affiliate

{
    "network_affiliate_ids":
    [
        24
    ],
    "account_status": "active",
    "affiliate_manager_id": 10,
    "network_traffic_source_id": 0
}

Response

{
  "result": true
}

Docs: Affiliate Tiers

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/affiliatetiers

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliatetiers' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "tiers": [
    {
      "network_affiliate_tier_id": 2,
      "network_id": 1,
      "name": "Gold10",
      "status": "active",
      "description": "Exemple",
      "network_affiliate_ids": [
        14,
        21,
        35
      ],
      "payout_margin": 10,
      "is_default_tier": false
    }
  ]
}

Find By ID

GET /v1/networks/affiliatetiers/:affiliateTierId

Path Parameters

Parameter	Description
affiliateTierId	The ID of the affiliate tier you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliatetiers/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_affiliate_tier_id": 1,
  "network_id": 1,
  "name": "Silver10",
  "status": "deleted",
  "description": "Exemple",
  "network_affiliate_ids": [
    28
  ],
  "payout_margin": 10,
  "is_default_tier": true 
}

Create

POST /v1/networks/affiliatetiers

Body Params

name string

The name of the affiliate tier

status string

Status of the affiliate tier. Can be one of the following values: active , paused or deleted.

description string

Optional description

network_affiliate_ids int array

ID of the Affiliates.

payout_margin int

The affiliate’s payout margin

is_default_tier boolean

Whether or not the affiliate tier will be automatically tied to all new partners.

Payload Example

    {
      "network_id": 1,
      "name": "Gold10",
      "status": "active",
      "description": "Exemple",
      "network_affiliate_ids": [
        14,
        21,
        35
      ],
      "payout_margin": 10,
      "is_default_tier": false
<span style="color:#000;font-weight:bold">}</span>

Update

PUT /v1/networks/affiliatetiers/:affiliateTierId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
affiliateTierId	The ID of the affiliate tier you want to update

Body Params

name string

The name of the affiliate tier

status string

Status of the affiliate tier. Can be one of the following values: active , paused or deleted.

description string

Optional description

network_affiliate_ids int array

ID of the Affiliates.

payout_margin int

The affiliate’s payout margin

is_default_tier boolean

Whether or not the affiliate tier will be automatically tied to all new partners.

Payload Example

{
  "network_id": 1,
  "name": "Platinum10",
  "status": "active",
  "description": "Exemple",
  "network_affiliate_ids": [
    14,
    21,
    35
  ],
  "payout_margin": 10,
  "is_default_tier": false
}

Docs: Affiliate Tracking Domains

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/affiliates/:affiliateId/trackingdomains

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose tracking domain you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/7/trackingdomains' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "tracking_domains": [
    {
      "network_affiliate_tracking_domain_id": 1,
      "network_id": 1,
      "network_affiliate_id": 7,
      "network_tracking_domain_id": 1,
      "is_apply_all_offers": true,
      "network_offer_id": 0,
      "relationship": {
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "Teddy Hopper Inc.",
          "account_status": "active",
          "network_traffic_source_id": 0
        },
        "tracking_domain": {
          "network_tracking_domain_id": 1,
          "network_id": 1,
          "url": "www.servetrack.test",
          "is_primary_domain": true,
          "domain_status": "active",
          "is_ssl_enabled": false,
          "notes": "",
          "renewal_date": "",
          "ownership": "internal",
          "html_static_redirect": "",
          "url_redirect": ""
        }
      }
    }
  ]
}

Find By ID

GET /v1/networks/affiliates/:affiliateId/trackingdomains/:affilliatetrackingDomainId

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose tracking domain you want to fetch
affilliatetrackingDomainId	The ID of the specific affiliate tracking ID setting you are trying to fetch AKA. network_affiliate_tracking_domain_id

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/1/trackingdomains/17' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "tracking_domains": [
    {
      "network_affiliate_tracking_domain_id": 17,
      "network_id": 1,
      "network_affiliate_id": 7,
      "network_tracking_domain_id": 1,
      "is_apply_all_offers": true,
      "network_offer_id": 0,
      "relationship": {
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "Teddy Hopper Inc.",
          "account_status": "active",
          "network_traffic_source_id": 0
        },
        "tracking_domain": {
          "network_tracking_domain_id": 1,
          "network_id": 1,
          "url": "www.servetrack.test",
          "is_primary_domain": true,
          "domain_status": "active",
          "is_ssl_enabled": false,
          "notes": "",
          "renewal_date": "",
          "ownership": "internal",
          "html_static_redirect": "",
          "url_redirect": ""
        }
      }
    }
  ]
}

Create

POST /v1/networks/affiliates/:affiliateId/trackingdomains

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate for whom to create a tracking domain

Body Params

network_affiliate_id int

ID of the affiliate for whom to create a tracking domain.

network_tracking_domain_id int

ID of the network tracking domain.

is_apply_all_offers boolean

Whether or not this tracking domain apply to all offer.

network_offer_ids array[int]

List of offer IDs to which the tracking domain will apply.

Payload Example

{
    "tracking_domains": [
        {
            "network_affiliate_tracking_domain_id": 4,
            "network_id": 1,
            "network_affiliate_id": 7,
            "network_tracking_domain_id": 2,
            "is_apply_all_offers": false,
            "network_offer_id": 42,
            "relationship": {
                "affiliate": {
                    "network_affiliate_id": 7,
                    "network_id": 1,
                    "name": "Ayumi Henry Inc.",
                    "account_status": "active",
                    "network_traffic_source_id": 0
                },
                "tracking_domain": {
                    "network_tracking_domain_id": 2,
                    "network_id": 1,
                    "url": "www.servetrack1.test",
                    "is_primary_domain": false,
                    "domain_status": "active",
                    "is_ssl_enabled": false,
                    "notes": "",
                    "time_created": 1603203203,
                    "time_saved": 1603203203,
                    "renewal_date": "",
                    "ownership": "internal",
                    "html_static_redirect": "",
                    "url_redirect": ""
                },
                "offer": {
                    "network_offer_id": 42,
                    "network_id": 1,
                    "network_advertiser_id": 26,
                    "network_offer_group_id": 0,
                    "name": "Car Uber",
                    "offer_status": "active",
                    "network_tracking_domain_id": 1,
                    "visibility": "public",
                    "currency_id": "USD"
                }
            }
        }
    ]
}

Update

PUT /v1/networks/affiliates/:affiliateId/trackingdomains

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose tracking domain you want to update

Body Params

network_affiliate_id int

ID of the affiliate for whom to create a tracking domain.

network_tracking_domain_id int

ID of the network tracking domain.

network_affiliate_tracking_domain_id int

The ID of the specific affiliate tracking ID setting to be updated

is_apply_all_offers boolean

Whether or not this tracking domain apply to all offer.

network_offer_id int

ID of the offer to which the tracking domain will apply.

Payload Example

{
  "network_offer_id": 42,
  "network_tracking_domain_id": 2,
  "network_affiliate_id": 7,
  "is_apply_all_offers": false,
  "network_affiliate_tracking_domain_id": 17
}

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/7/trackingdomains' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'\
--header 'content-type: application/json' \
--data '<INSERT PAYLOAD>'

{
    "network_affiliate_tracking_domain_id": 17,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_tracking_domain_id": 2,
    "is_apply_all_offers": false,
    "network_offer_id": 42,
    "relationship": {
        "affiliate": {
            "network_affiliate_id": 7,
            "network_id": 1,
            "name": "Ayumi Henry Inc.",
            "account_status": "active",
            "network_traffic_source_id": 0
        },
        "tracking_domain": {
            "network_tracking_domain_id": 2,
            "network_id": 1,
            "url": "www.servetrack.test",
            "is_primary_domain": true,
            "domain_status": "active",
            "is_ssl_enabled": false,
            "notes": "",
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "renewal_date": "",
            "ownership": "internal",
            "html_static_redirect": "",
            "url_redirect": ""
        },
        "offer": {
            "network_offer_id": 42,
            "network_id": 1,
            "network_advertiser_id": 39,
            "network_offer_group_id": 0,
            "name": "Cash Cash",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "require_approval",
            "currency_id": "USD"
        }
    }
}

Delete

DELETE /v1/networks/affiliates/:affiliateId/trackingdomains/:affilliatetrackingDomainId

Delete an existing specific tracking domain setting base on it’s ID

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose tracking domain you want to fetch
affilliatetrackingDomainId	The ID of the specific affiliate tracking ID setting you are trying to fetch AKA. network_affiliate_tracking_domain_id

Request Example

cURL

curl --request DELETE '/v1/networks/affiliates/:affiliateId/trackingdomains/:affilliatetrackingDomainId' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "success": true
}

Docs: Affiliate Users

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/affiliates/:affiliateId/users

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose users you want to fetch

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
logins	Includes the users’ list of logins
password_history	Includes the users’ password changes history
api	Includes the users’ API key and whitelisted IPs
affiliate_status	Include the status of the affiliate to which the user belong
customizations	Includes the users’ customizations

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/7/users' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "users": [
        {
            "network_affiliate_user_id": 17,
            "network_id": 1,
            "network_affiliate_id": 1,
            "first_name": "Bob",
            "last_name": "Smith",
            "email": "my.everflow@gmail.com",
            "title": "",
            "work_phone": "9655433513",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": "",
            "language_id": 1,
            "timezone_id": 75,
            "currency_id": "USD",
            "account_status": "active",
            "relationship": 
                {
                    "affiliate_account_status": "active"
                }
        }
    ]
}

Find By ID

GET /v1/networks/affiliates/:affiliateId/users/:userId

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose user you want to fetch
userId	The ID of the user you want to fetch

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
logins	Includes the user’s list of logins
password_history	Includes the user’s password changes history
api	Includes the user’s API key and whitelisted IPs
affiliate_status	Include the status of the affiliate to which the user belong
customizations	Includes the users’ customizations

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/affiliates/1/users/17' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "network_affiliate_user_id": 17,
    "network_id": 1,
    "network_affiliate_id": 13,
    "first_name": "Bob",
    "last_name": "Smith",
    "email": "my.everflow@gmail.com",
    "title": "CEO",
    "work_phone": "9655433513",
    "cell_phone": "",
    "instant_messaging_id": 0,
    "instant_messaging_identifier": "",
    "language_id": 1,
    "timezone_id": 75,
    "currency_id": "USD",
    "account_status": "active",
    "relationship": 
        {
            "affiliate_account_status": "active"
        }   
}

Create

POST /v1/networks/affiliates/:affiliateId/users

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate for whom to create a user

Body Params

first_name string

The affiliate user’s first name

last_name string

The affiliate user’s last name

email string

The affiliate user’s email. Must be unique among all affiliate users. Is used to log in the platform.

language_id int

The affiliate user’s language id. This is limited to the value 1 (English).

timezone_id int

The affiliate user’s timezone id. Can be found using the metadata API.

title string

The affiliate user’s title.

work_phone string

The affiliate user’s work phone number.

cell_phone string

The affiliate user’s cell phone number.

instant_messaging_id int

The id of an instant messaging platform. Allows you to save their identifier for further reference.

instant_messaging_identifier string

The affiliate user’s instant messaging identifier, if instant_messaging_id was different than 0.

currency_id string

The affiliate user’s currency id. Can be found using the metadata API (insert link)

account_status string

The affiliate user’s account status. Can be either active or inactive.

initial_password string

The affiliate user’s login password. If left empty, the affiliate will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters.

Payload Example

{
    "currency_id": "USD",
    "instant_messaging_id": 0,
    "account_status": "active",
    "language_id": 1,
    "timezone_id": 90,
    "initial_password": "",
    "first_name": "Bob",
    "last_name": "Smith",
    "title": "CEO",
    "work_phone": "1234567788",
    "email": "my.everflow@gmail.com",
    "relationship": 
        {
            "affiliate_account_status": "active"
        }
}

Update

PUT /v1/networks/affiliates/:affiliateId/users/:userId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate whose user you want to update
userId	The ID of the user you want to update

Body Params

first_name string

The affiliate user’s first name

last_name string

The affiliate user’s last name

email string

The affiliate user’s email. Must be unique among all affiliate users. Is used to log in the platform.

title string

The affiliate user’s title.

work_phone string

The affiliate user’s work phone number.

cell_phone string

The affiliate user’s cell phone number.

instant_messaging_id int

The id of an instant messaging platform. Allows you to save their identifier for further reference.

instant_messaging_identifier string

The affiliate user’s instant messaging identifier, if instant_messaging_id was different than 0.

language_id int

The affiliate user’s language id. This is limited to the value 1 (English).

timezone_id int

The affiliate user’s timezone id. Can be found using the metadata API.

currency_id string

The affiliate user’s currency id. Can be found using the metadata API (insert link)

account_status string

The affiliate user’s account status. Can be either active or inactive.

initial_password string

The affiliate user’s login password.

Payload Example

{
    "currency_id": "USD",
    "instant_messaging_id": 0,
    "account_status": "active",
    "language_id": 1,
    "timezone_id": 90,
    "initial_password": "",
    "first_name": "Bob",
    "last_name": "Smith",
    "title": "CEO",
    "work_phone": "1234567788",
    "email": "my.everflow@gmail.com",
    "relationship": 
        {
            "affiliate_account_status": "active"
        }
}

Docs: Business Units

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/businessunits

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/businessunits' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "units": [
    {
      "network_business_unit_id": 1,
      "network_id": 1,
      "name": "Marketing"
    },
    {
      "network_business_unit_id": 2,
      "network_id": 1,
      "name": "Manufacturing"
    }
  ]
}

Find By ID

GET /v1/networks/businessunits/:businessUnitId

Path Parameters

Parameter	Description
businessUnitId	The ID of the business unit you want to find

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/businessunits/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_business_unit_id": 1,
  "network_id": 1,
  "name": "Marketing"
}

Create

POST /v1/networks/businessunits

Body Params

name string

Name of the business unit.

Payload Example

{
    "name": "Manufacturing" 
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/businessunits' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
    "network_business_unit_id": 1,
    "network_id": 1,
    "name": "Manufacturing",
    "time_created": 1603827008,
    "time_saved": 1603827008
}

Update

PUT /v1/networks/businessunits/:businessUnitId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
businessUnitId	The ID of the business unit you want to update

Body Params

name string

Name of the business unit.

Payload Example

{
  "name": "Marketing"
}

Request Example

cURL

curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/businessunits/<INSERT BUSINESS UNIT ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
    "network_business_unit_id": 1,
    "network_id": 1,
    "name": "Marketing",
    "time_created": 1603827008,
    "time_saved": 1603827008
}

Docs: Categories

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/categories

This endpoint returns all categories on your account.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "categories": [
    {
      "network_category_id": 1,
      "network_id": 1,
      "name": "Finance",
      "status": "active",
      "time_created": 1489692867,
      "time_saved": 1489692867
    }
  ]
}

Find By ID

GET /v1/networks/categories/:categoryId

This is the endpoint that will return a singular categories.

Path Parameters

Parameter	Description
categoryId	The ID of the category you want to find

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/categories/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "network_category_id": 1, "network_id": 1, "name": "Finance", "status": "active", "time_created": 1489692867, "time_saved": 1489692867 }

Create

POST /v1/networks/categories

Request Body

Body Params

name string

Name of the category.

status string

Status of the category. Can either be active or inactive.

Body Example

{
  "name": "Finance",
  "status": "active"
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Response

{
  "network_category_id": 1,
  "network_id": 1,
  "name": "Finance",
  "status": "active",
  "time_created": 1489692867,
  "time_saved": 1489692867
}

Update

PUT /v1/networks/categories/:categoryId

You must specify all the fields, not only the ones you wish to update.

Path Parameters

Parameter	Description
categoryId	The ID of the category you want to update

Request Body

Body Params

name string

Name of the category.

status string

Status of the category. Can either be active or inactive.

Body Example

{
  "name": "Finance",
  "status": "inactive"
}

Request Example

cURL

curl --request PUT 'https://api.eflow.team/v1/networks/categories' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Response

{
  "network_category_id": 1,
  "network_id": 1,
  "name": "Finance",
  "status": "inactive",
  "time_created": 1489692867,
  "time_saved": 1717605352
}

Docs: Channels

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/channels

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/channels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "channels": [
    {
      "network_channel_id": 1,
      "network_id": 1,
      "name": "TestChannel",
      "status": "active",
      "relationship": {
			"offers_count": "1"
	  }
    }
  ]
}

Find By ID

GET /v1/networks/channels/:channelId

Path Parameters

Parameter	Description
channelId	The ID of the channel you want to find

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/channels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "TestChannel",
  "status": "inactive",
  "relationship": {
        "offers_count": "1"
  }
}

Create

POST /v1/networks/channels

Body Params

name string

Name of the channel.

status string

Status of the channel. Can either be active or inactive.

Payload Example

{
  "name": "ChannelName",
  "status": "active"
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/channels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "ChannelName",
  "status": "active",
  "relationship": {},
  "time_created": 1579163366,
  "time_saved": 1579163366
}

Update

PUT /v1/networks/channels/:channelId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
channelId	The ID of the channel you want to update

Body Params

name string

Name of the channel.

status string

Status of the channel. Can either be active or inactive.

relationship object

View Object Details Hide Object Details

offers_count int

Number of offer in the channel.

Payload Example

{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "TestChannel",
  "status": "inactive",
  "relationship": {
        "offers_count": "1"
  }
}

Delete

DELETE /v1/networks/channels/:channelId

Path Parameters

Parameter	Description
channelId	The ID of the channel you want to delete

Request Example

cURL

curl --request DELETE \
  --url 'https://api.eflow.team/v1/networks/channels/:channelId" \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \

Response

{
  "result": true
}

Docs: Conversion Updates

Mon, 01 Jan 0001 00:00:00 +0000

While conversions are mostly immutable in Everflow, there are a few properties that can be updated. They are :

The status of the conversion (approved, rejected, etc.)
The payout and revenue associated with a conversion
The sale amount associated with a conversion

All other properties (query parameters like adv1, adv2, etc.) cannot be modified after the creation of the conversion.

Note that updating the conversion will create an entry in the conversion history.

Update Conversion Status

PATCH /v1/networks/reporting/conversions

This endpoint allows you to modify the status of multiple conversions at the same time.

There are 4 possible status to Everflow conversions :

approved
rejected
pending
invalid

but a conversion cannot be updated to the pending or invalid status. Only approved and rejected are accepted values on this endpoint.

Note that the endpoint is asynchronous. Even when the endpoint returns true immediately, it may take up to a few seconds for the conversion updates to be processed (and to fire partner pixels if appropriate). Though this is a rare occurrence, the endpoint may return true even if the update ultimately fails when it is processed.

Request Body

Body Param

conversion_ids string array

Conversion IDs of the conversions to be updated.

conversion_status string

New status of the conversion. Must be approved or rejected

Body Example

{
    "conversion_ids": [
        "baab7e25bba046e6b080c799729c5cba",
        "a91a421038ab46b694547f4db636db80",
        "ca62c52cc745486bbf438f96fc24d6a8"
    ],
    "conversion_status": "rejected"
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/conversions' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example : Setting a single conversion as rejected

{
	"conversion_ids": [
		"9e6e4d8389f04c42825d81fee6360297"
	],
	"conversion_status": "approved"
}

Response

{
  "result": true
}

Update Conversion Status by Transaction ID

PATCH /v1/networks/reporting/conversions/:transactionId

This endpoint allows you to modify the status of all conversions / events linked to a single transaction ID.

There are 4 possible status to Everflow conversions :

approved
rejected
pending
invalid

but a conversion cannot be updated to the pending or invalid status. Only approved and rejected are accepted values on this endpoint.

Conversions that are invalid will be ignored on this endpoint. Only approved, rejected and pending conversions will be updated.

Request Body

Body Param

conversion_status string

New status of the conversion. Must be approved or rejected

Body Example

{
    "conversion_status": "rejected"
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example : Setting all the conversions linked to a transaction ID as approved

{
    "conversion_status": "approved"
}

Response

{
  "result": true
}

Update Conversion Payout and Revenue

PUT /v1/networks/reporting/conversions/:conversionId/payoutrevenue

This endpoint allows you to update the payout and revenue amounts associated with a conversion. Note that only approved conversions (or throttled conversions) can be updated through this endpoint.

Note that these amounts be only be absolute values. Even if the offer is setup as RPS with 20% revenue for example, it cannot be updated to 25% revenue - it must be updated to e.g. 5.75.

This endpoint also doesn’t take a currency. The currency of the offer will be used.

Note that the endpoint is asynchronous. Even when the endpoint returns true immediately, it may take up to a few seconds for the conversion update to be processed.

Path Parameters

Parameter	Description
conversionId	The ID of the conversion that must be updated

Body Params

payout decimal

The amount of the partner payout.

revenue decimal

The amount of the revenue.

Request Examples

cURL

curl --request PUT 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297/payoutrevenue' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "payout": 4.25,
    "revenue": 5
}'

Response

{
  "result": true
}

Update Conversion Sale Amount

PUT /v1/networks/reporting/conversions/:conversionId/saleamount

This endpoint allows you to update the sale amount associated with a conversion.

Note that this using this endpoint will never affect the value of the payout and revenue amounts. Even in a case where an offer is setup as CPS / RPS, update the sale amount still will not change the payout and revenue.

This endpoint also doesn’t take a currency. The currency of the offer will be used.

Note that the endpoint is asynchronous. Even when the endpoint returns true immediately, it may take up to a few seconds for the conversion update to be processed.

Path Parameters

Parameter	Description
conversionId	The ID of the conversion that must be updated

Body Params

sale_amount decimal

The new sale amount associated with the conversion.

Request Examples

cURL

curl --request PUT 'https://api.eflow.team/v1/networks/reporting/conversions/9e6e4d8389f04c42825d81fee6360297/saleamount' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "sale_amount" : 199.99
}'

Response

{
  "result": true
}

Update On Hold Conversion Status

PATCH /v1/networks/reporting/onhold

This endpoint allows you to modify the status of multiple on hold conversions at the same time.

There are 3 possible status to Everflow on hold conversions :

approved
rejected
on_hold

but an on hold conversion cannot be updated to the on_hold status. Only approved and rejected are accepted values on this endpoint. An on hold conversion that has already been approved cannot be updated to rejected.

Note that the endpoint is asynchronous. Even when the endpoint returns true immediately, it may take up to a few seconds for the on hold conversion updates to be processed (and to create actual conversions if appropriate). Though this is a rare occurrence, the endpoint may return true even if the update ultimately fails when it is processed.

Request Body

Body Param

on_hold_conversion_ids string array

On hold conversion IDs of the on hold conversions to be updated.

status string

New status of the on hold conversion. Must be approved or rejected.

Body Example

{
    "on_hold_conversion_ids": [
        "baab7e25bba046e6b080c799729c5cba",
        "a91a421038ab46b694547f4db636db80",
        "ca62c52cc745486bbf438f96fc24d6a8"
    ],
    "status": "approved"
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/reporting/onhold' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example : Setting a single on hold conversion as rejected

{
	"on_hold_conversion_ids": [
		"9e6e4d8389f04c42825d81fee6360297"
	],
	"status": "rejected"
}

Response

{
  "result": true
}

Docs: Coupon Codes

Mon, 01 Jan 0001 00:00:00 +0000

Coupon Codes are a feature that allow you to track performance using codes unique to each partner. They are documented in detail on the Everflow Helpdesk.

Find All

GET /v1/networks/couponcodes

Filters

This endpoint supports the following API filters. Refer to our User Guide for usage.

Value	Description
time_created	Filter based on the creation time
time_saved	Filter based on the last update time
coupon_status	Filter based on the coupon status
coupon_code	Filter based on the coupon name
network_offer_id	Filter based on the offer id
network_affiliate_id	Filter based on the affiliate id

Relationships

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

Value	Description
offer	Includes the offer information
affiliate	Includes the affiliate information

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/couponcodes' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "coupon_codes": [
    {
      "network_coupon_code_id": 1,
      "network_id": 1,
      "network_affiliate_id": 14,
      "network_offer_id": 4,
      "coupon_code": "SUMMER15",
      "coupon_status": "active",
      "internal_notes": "This coupon is only available to new customers",
      "description": "15% off for all store during the summer",
      "is_description_plain_text": true,
      "start_date": "2025-06-01",
      "end_date": "2025-09-30",
      "time_created": 1709132517,
      "time_saved": 1709132517
    }
  ]
}

Find By ID

GET /v1/networks/couponcodes/:couponCodeId

Path Parameters

Parameter	Description
couponCodeId	The ID of the coupon code you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/couponcodes/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_coupon_code_id": 1,
  "network_id": 1,
  "network_affiliate_id": 7,
  "network_offer_id": 6,
  "coupon_code": "SUMMER15",
  "coupon_status": "active",
  "internal_notes": "This coupon is only available to new customers",
  "description": "15% off for all store during the summer",
  "is_description_plain_text": true,
  "start_date": "2025-06-01",
  "end_date": "2025-09-30",
  "time_created": 1709132517,
  "time_saved": 1709132517
}

Create

POST /v1/networks/couponcodes

Body Params

network_offer_id int

ID of the offer for which the coupon applies.

network_affiliate_id int

ID of the Affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.

coupon_code string

Coupon code value

coupon_status string

Status of the coupon code. Can be one of the following values: active or paused.

internal_notes string

Notes for internal usage – they will not be visible to the partner.

description string

A description (either plain text or HTML) that will be visible to the partner

is_description_plain_text bool

Only relevant when a description is provided. Determines if the description is in HTML or plain text format

start_date string

An optional date starting at which the coupon code can be used. Use the YYYY-mm-DD format

end_date string

An optional date at which the coupon code becomes obsolete. Use the YYYY-mm-DD format

Payload Example

{
  "network_affiliate_id": 21,
  "network_offer_id": 91,
  "coupon_status": "active",
  "coupon_code": "SUMMER20",
  "start_date": "2025-06-01",
  "end_date": "2025-09-01",
  "description": "20% off all store purchases during the summer",
  "is_description_plain_text": true,
  "internal_notes": "Only available to new customers"
}

Update

PUT /v1/networks/couponcodes/:couponCodeId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
couponCodeId	The ID of the coupon code you want to update

Body Params

network_offer_id int

ID of the offer for which the coupon applies.

network_affiliate_id int

ID of the Affiliate for which the coupon applies. A coupon code without an affiliate specified can exist but cannot be used.

coupon_code string

Coupon code value

coupon_status string

Status of the coupon code. Can be one of the following values: active or paused.

internal_notes string

Notes for internal usage – they will not be visible to the partner.

description string

A description (either plain text or HTML) that will be visible to the partner

is_description_plain_text bool

Only relevant when a description is provided. Determines if the description is in HTML or plain text format

start_date string

An optional date starting at which the coupon code can be used. Use the YYYY-mm-DD format

end_date string

An optional date at which the coupon code becomes obsolete. Use the YYYY-mm-DD format

Payload Example

{
  "network_coupon_code_id": 1,
  "network_id": 1,
  "network_affiliate_id": 14,
  "network_offer_id": 4,
  "coupon_code": "Summer20",
  "coupon_status": "paused",
  "internal_notes": "This coupon is only available to new customers",
  "start_date": "2020-06-01",
  "end_date": "2020-09-30"
}

Delete

DELETE /v1/networks/couponcodes/:couponCodeId

Path Parameters

Parameter	Description
couponCodeId	The ID of the coupon code you want to delete

Request Example

cURL

curl --request DELETE 'https://api.eflow.team/v1/networks/couponcodes/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "result": true
}

Docs: Creatives

Mon, 01 Jan 0001 00:00:00 +0000

Fetch Creatives

POST /v1/networks/creativestable

This is the main endpoint to extract a list of creatives from the API. It’s possible to filter the postbacks returned by this endpoint using search / filters on :

The creative’s name (name)
The creative’s status (creative_status)
The creative’s type (creative_type) : the types can be image, html, thumbnail, email, archive, video, text, link
The creative’s offer name (network_offer_name)
The creative’s offer id (network_offer_id)

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

View Object Details Hide Object Details

search_type string

The name of the field used for search. Can be one of the following values: name, creative_status or creative_type, network_offer_name, network_offer_id. The name option can be used to search with a creative ID as well.

value string

The value to search.

Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/creativestable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch all active creatives

{
  "search_terms": [
    {
      "search_type": "creative_status",
      "value": "active"
    }
  ]
}

To fetch, for example, the second page of 50 active creatives postbacks you would run the following call :

curl --request POST 'https://api.eflow.team/v1/networks/creativestable?page=2&page_size=50' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "search_terms": [
    {
      "search_type": "creative_status",
      "value": "active"
    }
  ]
}'

Example 2 : Fetch active creatives linked to offer ID 178

{
  "search_terms": [
    {
      "search_type": "creative_status",
      "value": "active"
    },
    {
      "search_type": "network_offer_id",
      "value": "178"
    }
  ]
}

Example 3 : Fetch creatives with a name that contains the word “Christmas”

{
  "search_terms": [
    {
      "search_type": "network_offer_name",
      "value": "Christmas"
    }
  ]
}

Example 4 : Fetch active creatives of type “email”

{
  "search_terms": [
    {
      "search_type": "creative_status",
      "value": "active"
    },
    {
      "search_type": "creative_type",
      "value": "email"
    }
  ]
}

Response

{
  "creatives": [
    {
      "network_offer_creative_id": 20985,
      "network_id": 1,
      "name": "exemple creative 1",
      "network_offer_id": 5,
      "network_offer_name": "Example Offer CPA",
      "creative_type": "image",
      "is_private": false,
      "creative_status": "active",
      "resource_url": "https://1.efuserassets.com/1/offers/5/c/1234/image.png",
      "html_code": "",
      "width": 300,
      "height": 300,
      "email_from": "",
      "email_subject": "",
      "time_created": 1607093608,
      "time_saved": 1607093608,
      "optimized_thumbnail_url": "https://1.efuserassets.com/thumbnails/1/offers/5/c/1234/image.png"
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 10,
    "total_count": 2
  }
}

Find By ID

GET /v1/networks/creatives/:creativeId

Path Parameters

Parameter	Description
creativeId	The ID of the creative you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/creatives/<INSERT CREATIVE ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_offer_creative_id": 1,
  "network_id": 1,
  "network_offer_id": 73,
  "name": "test",
  "creative_type": "image",
  "is_private": false,
  "creative_status": "active",
  "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
  "html_code": "",
  "width": 0,
  "height": 0,
  "email_from": "",
  "email_subject": "",
  "time_created": 1602865402,
  "time_saved": 1602865403,
  "relationship": {
    "offer": {
      "network_offer_id": 73,
      "network_id": 1,
      "network_advertiser_id": 39,
      "network_offer_group_id": 0,
      "name": "Candy Crush",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    },
    "resource_asset": {
      "network_asset_id": 1,
      "content_type": "image/png",
      "filename": "testcreative.png",
      "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
      "file_size": 5287,
      "image_width": 0,
      "image_height": 0
    }
  },
  "additional_offer_ids": null,
  "is_apply_specific_affiliates": false
}

Create

POST /v1/networks/creatives

Body Params

network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation)

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, link, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html, email or link.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

additional_offer_ids int array

ID of all offer linked to this creative.

is_apply_specific_affiliates boolean

Whether or not you want to apply to specific affiliates. Defaults to false.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

html_assets object array

View Object Details Hide Object Details

content_type string

The type of content in the asset. //NOT SURE

filename string

Name of the file.

url string

URL of the file, obtained by uploading the file through the API.

file_size int

Size of the file.

image_width int

Width of the creative. Required only if creative_type is image.

image_height int

Height of the creative. Required only if creative_type is image.

Payload Example

{
  "network_offer_id": 73,
  "name": "",
  "creative_type": "image",
  "is_private": false,
  "creative_status": "active",
  "html_code": "",
  "width": 0,
  "height": 0,
  "email_from": "",
  "email_subject": "",
  "additional_offer_ids": [],
  "is_apply_specific_affiliates": false,
  "resource_file": {
    "temp_url": "https://usercontent-dev.everflowclient.io/1/temp/30e093f3-54bd-445f-9afb-291e506af466",
    "original_file_name": "original_name"
  },
  "html_files": [
    {
      "temp_url": "",
      "original_file_name": ""
    }
  ],
  "html_assets": [
    {
      "content_type": "",
      "filename": "",
      "url": "",
      "file_size": 0,
      "image_width": 0,
      "image_height": 0
    }
  ]
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/creatives' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "network_offer_creative_id": 10,
  "network_id": 1,
  "network_offer_id": 73,
  "name": "",
  "creative_type": "image",
  "is_private": false,
  "creative_status": "active",
  "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
  "html_code": "",
  "width": 0,
  "height": 0,
  "email_from": "",
  "email_subject": "",
  "time_created": 1603890208,
  "time_saved": 1603890209,
  "relationship": {
    "offer": {
      "network_offer_id": 73,
      "network_id": 1,
      "network_advertiser_id": 39,
      "network_offer_group_id": 0,
      "name": "Candy Crush",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    },
    "resource_asset": {
      "network_asset_id": 7,
      "content_type": "image/gif",
      "filename": "original_name",
      "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
      "file_size": 6,
      "image_width": 0,
      "image_height": 0
    }
  },
  "additional_offer_ids": null,
  "is_apply_specific_affiliates": false
}

Update

PUT /v1/networks/creatives/:creativeId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
creativeId	The ID of the creative you want to update

Body Params

network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation)

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html, email or link.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

additional_offer_ids int array

ID of all offer linked to this creative.

is_apply_specific_affiliates boolean

Whether or not you want to apply to specific affiliates. Defaults to false.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

html_assets object array

View Object Details Hide Object Details

content_type string

The type of content in the asset. //NOT SURE

filename string

Name of the file.

url string

URL of the file, obtained by uploading the file through the API.

file_size int

Size of the file.

image_width int

Width of the creative. Required only if creative_type is image.

image_height int

Height of the creative. Required only if creative_type is image.

Payload Example

{
  "network_offer_id": 73,
  "name": "",
  "creative_type": "image",
  "is_private": false,
  "creative_status": "active",
  "html_code": "",
  "width": 0,
  "height": 0,
  "email_from": "",
  "email_subject": "",
  "additional_offer_ids": [],
  "is_apply_specific_affiliates": false,
  "resource_file": {
    "temp_url": "https://usercontent-dev.everflowclient.io/1/temp/30e093f3-54bd-445f-9afb-291e506af466",
    "original_file_name": "original_name"
  },
  "html_files": [
    {
      "temp_url": "",
      "original_file_name": ""
    }
  ],
  "html_assets": [
    {
      "content_type": "",
      "filename": "",
      "url": "",
      "file_size": 0,
      "image_width": 0,
      "image_height": 0
    }
  ]
}

Request Example

cURL

curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/creatives/<INSERT CREATIVE ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "network_offer_creative_id": 10,
  "network_id": 1,
  "network_offer_id": 73,
  "name": "",
  "creative_type": "image",
  "is_private": false,
  "creative_status": "active",
  "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
  "html_code": "",
  "width": 0,
  "height": 0,
  "email_from": "",
  "email_subject": "",
  "time_created": 1603890208,
  "time_saved": 1603890209,
  "relationship": {
    "offer": {
      "network_offer_id": 73,
      "network_id": 1,
      "network_advertiser_id": 39,
      "network_offer_group_id": 0,
      "name": "Candy Crush",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    },
    "resource_asset": {
      "network_asset_id": 7,
      "content_type": "image/gif",
      "filename": "original_name",
      "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
      "file_size": 6,
      "image_width": 0,
      "image_height": 0
    }
  },
  "additional_offer_ids": null,
  "is_apply_specific_affiliates": false
}

Bulk Edit

PATCH /v1/networks/patch/offers/creative/apply

This endpoint allows you to update selected fields of one or multiple creatives at the same time. It does not require the entire creative object to be passed in the payload. Only the properties that need to be changed must be supplied.

Request Body

Body Param

network_offer_creative_ids int array

IDs of the creatives to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the creatives. For the fields that are currently patchable, this will always be overwrite.

Body Example

{
  "network_offer_creative_ids": [1, 3],
  "fields": [
    {
      "field_type": "creative_status",
      "field_value": "paused",
      "operator": "overwrite"
    },
    {
      "field_type": "name",
      "field_value": "New Patched Name",
      "operator": "overwrite"
    },
    {
      "field_type": "is_private",
      "field_value": true,
      "operator": "overwrite"
    }
  ]
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/patch/offers/creative/apply' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Pause multiple creatives at the same time :

{
  "network_offer_creative_ids": [3, 12],
  "fields": [
    {
      "field_type": "creative_status",
      "field_value": "paused",
      "operator": "overwrite"
    }
  ]
}

Response

{
  "result": true
}

Patchable Fields

The fields below are to be used in the Bulk Edit and Patch Preview endpoints documented above.

Fields

name string

The name of the creative

is_private bool

Determines whether a creative is visible to partners or not.

creative_status string

The status of the creative. Can be active, paused or deleted

Docs: Custom Caps

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/custom/caps

Paging

This endpoint supports paging. Refer to our User Guide for usage.

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
time_created	Filter based on the creation time
time_saved	Filter based on the last update time

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/custom/caps' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

 {
     "custom_cap_settings": [
     {
         "network_custom_cap_setting_id": 0,
         "network_id": 0,
         "network_affiliate_id": 0,
         "network_offer_id": 0,
         "name": "Custum Cap Example",
         "daily_conversion_cap": 0,
         "weekly_conversion_cap": 0,
         "monthly_conversion_cap": 0,
         "global_conversion_cap": 0,
         "daily_payout_cap": 0,
         "weekly_payout_cap": 0,
         "monthly_payout_cap": 0,
         "global_payout_cap": 0,
         "daily_click_cap": 0,
         "weekly_click_cap": 0,
         "monthly_click_cap": 0,
         "global_click_cap": 0,
         "daily_revenue_cap": 0,
         "weekly_revenue_cap": 0,
         "monthly_revenue_cap": 0,
         "global_revenue_cap": 0,
         "time_created": 1493662646,
         "time_saved": 1493662646,
         "relationship":
         {
             "affiliate":
             {
                 "network_affiliate_id": 0,
                 "network_id": 0,
                 "name": "Affiliate Example",
                 "account_status": "inactive",
                 "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": 1493662524,
                 "time_saved": 1495028680,
                 "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": "paused",
                 "network_tracking_domain_id": 0,
                 "visibility": "public",
                 "currency_id": "USD"
             },
             "currency_id": "USD"
         }
     }],
     "paging":
     {
         "page": 1,
         "page_size": 50,
         "total_count": 54
     }
 }

Find By ID

GET /v1/networks/custom/caps/:settingId

Path Parameters

Parameter	Description
settingId	The ID of a network custom setting

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/custom/caps/<INSERT SETTING ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

 {
     "network_custom_cap_setting_id": 0,
     "network_id": 0,
     "network_affiliate_id": 0,
     "network_offer_id": 0,
     "name": "Custom Cap Example",
     "daily_conversion_cap": 0,
     "weekly_conversion_cap": 0,
     "monthly_conversion_cap": 0,
     "global_conversion_cap": 0,
     "daily_payout_cap": 0,
     "weekly_payout_cap": 0,
     "monthly_payout_cap": 0,
     "global_payout_cap": 0,
     "daily_click_cap": 0,
     "weekly_click_cap": 0,
     "monthly_click_cap": 0,
     "global_click_cap": 0,
     "daily_revenue_cap": 0,
     "weekly_revenue_cap": 0,
     "monthly_revenue_cap": 0,
     "global_revenue_cap": 0,
     "time_created": 1493662524,
     "time_saved": 1493662524,
     "relationship":
     {
         "affiliate":
         {
             "network_affiliate_id": 0,
             "network_id": 0,
             "name": "Affiliate Example",
             "account_status": "inactive",
             "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": 0,
             "time_saved": 1594668150,
             "referrer_id": 1594668150
         },
         "offer":
         {
             "network_offer_id": 0,
             "network_id": 0,
             "network_advertiser_id": 0,
             "network_offer_group_id": 0,
             "name": "Offer Example",
             "offer_status": "paused",
             "network_tracking_domain_id": 0,
             "visibility": "public",
             "currency_id": "USD"
         },
         "currency_id": "USD"
     }
 }

Create

POST /v1/networks/custom/caps

Body Params

network_affiliate_id int

The affiliate id.

network_offer_id int

The offer id.

name string

The custom cap setting name.

daily_conversion_cap int

The daily conversion cap.

weekly_conversion_cap int

The weekly conversion cap.

monthly_conversion_cap int

The monthly conversion cap.

global_conversion_cap int

The global conversion cap.

daily_payout_cap number

The daily payout cap.

weekly_payout_cap number

The weekly payout cap.

monthly_payout_cap number

The monthly payout cap.

global_payout_cap number

The global payout cap.

daily_click_cap int

The daily click cap.

weekly_click_cap int

The weekly click cap.

monthly_click_cap int

The monthly click cap.

global_click_cap int

The global click cap.

daily_revenue_cap number

The daily revenue cap.

weekly_revenue_cap number

The weekly revenue cap.

monthly_revenue_cap number

The monthly revenue cap.

global_revenue_cap number

The global revenue cap.

Payload Example

{
  "network_affiliate_id": 11,
  "network_offer_id": 234,
  "name": "Custom Cap Example",
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 125,
  "daily_payout_cap": 10.3,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 300.50,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 250000,
  "global_click_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/caps' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "network_custom_cap_setting_id": 4,
  "network_id": 64,
  "network_affiliate_id": 11,
  "network_offer_id": 234,
  "name": "Custom Cap Example",
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 125,
  "daily_payout_cap": 10.3,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 300.50,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 250000,
  "global_click_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0,
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 11,
      "network_id": 64,
      "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": 0,
      "referrer_id": 0
    },
    "offer": {
      "network_offer_id": 234,
      "network_id": 64,
      "network_advertiser_id": 0,
      "network_offer_group_id": 0,
      "name": "Offer Example",
      "offer_status": "active",
      "network_tracking_domain_id": 0,
      "visibility": "public",
      "currency_id": ""
    },
    "currency_id": ""
  }
}

Patch

PATCH /v1/networks/custom/caps

Body Params

network_custom_cap_setting_ids int array

List of network custom cap setting ids separated by comas.

fields object array

List of fields to update.

View Object Details Hide Object Details

field_type string

Allowed values: daily_conversion_cap, weekly_conversion_cap, monthly_conversion_cap, global_conversion_cap, daily_payout_cap, weekly_payout_cap, monthly_payout_cap, global_payout_cap, daily_click_cap, weekly_click_cap, monthly_click_cap, global_click_cap, daily_revenue_cap, weekly_revenue_cap, monthly_revenue_cap, global_revenue_cap

field_value dynamic

WARNING: dynamic value, please see endpoint docs

Payload Example

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

Request Example

cURL

curl --request PATCH \
  --url 'https://api.eflow.team/v1/networks/custom/caps' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Docs: Custom Creatives

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/custom/creative

Filters

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

Value	Description
custom_setting_status	Filter based on the custom setting status
time_created	Filter based on the creation time
time_saved	Filter based on the last update time

Request Example

cURL

curl --request GET \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json'

Response

 {
  "custom_creative_settings": [
    {
      "network_custom_creative_setting_id": 0,
      "network_id": 0,
      "network_offer_creative_ids": [
        0
      ],
      "network_affiliate_ids": [
        0
      ],
      "name": "",
      "custom_setting_status": "active",
      "time_created": 0,
      "time_saved": 0,
      "relationship": {
        "affiliates": [
          {
            "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
          }
        ],
        "creative": {
          "network_offer_creative_id": 0,
          "network_id": 0,
          "network_offer_id": 0,
          "name": "",
          "creative_type": "image",
          "is_private": true,
          "creative_status": "active",
          "resource_url": "",
          "html_code": "",
          "width": 0,
          "height": 0,
          "email_from": "",
          "email_subject": "",
          "time_created": 0,
          "time_saved": 0,
          "additional_offer_ids": [
            0
          ],
          "is_apply_specific_affiliates": true
        }
      }
    }
  ]
}

Find By ID

GET /v1/networks/custom/creative/:settingId

Path Parameters

Parameter	Description
settingId	The ID of a network custom setting

Request Example

cURL

curl --request GET --url 'https://api.eflow.team/v1/networks/custom/creative/<INSERT SETTING ID>' \
--header 'x-eflow-api-key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

 {
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "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
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Create

POST /v1/networks/custom/creative

Body Params

network_offer_creative_ids array[int]

network_affiliate_ids array[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.

creative object

View Object Details Hide Object Details

network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation).

name string

creative_type string

Allowed values: image, html, thumbnail, email, archive, video, text.

is_private boolean

creative_status string

Allowed values: active, deleted.

html_code string

Only required when creative_type is ‘html’ or ‘email’.

width int

Only required when creative_type is ‘html’.

height int

Only required when creative_type is ‘html’.

email_from string

Only required when creative_type is ‘email’.

email_subject string

Only required when creative_type is ‘email’.

additional_offer_ids array[int]

is_apply_specific_affiliates boolean

resource_file object

View Object Details Hide Object Details

temp_url string

original_file_name string

html_files array[object]

View Object Details Hide Object Details

temp_url string

original_file_name string

html_assets array[object]

View Object Details Hide Object Details

content_type string

filename string

url string

file_size int

image_width int

image_height int

Payload Example

{
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "creative": {
    "network_offer_id": 0,
    "name": "",
    "creative_type": "image",
    "is_private": true,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [
      0
    ],
    "is_apply_specific_affiliates": true,
    "resource_file": {
      "temp_url": "",
      "original_file_name": ""
    },
    "html_files": [
      {
        "temp_url": "",
        "original_file_name": ""
      }
    ],
    "html_assets": [
      {
        "content_type": "",
        "filename": "",
        "url": "",
        "file_size": 0,
        "image_width": 0,
        "image_height": 0
      }
    ]
  }
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "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
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Update

PUT /v1/networks/custom/creative/:settingId

Body Params

network_offer_creative_ids array[int]

network_affiliate_ids array[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.

creative object

View Object Details Hide Object Details

network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation).

name string

creative_type string

Allowed values: image, html, thumbnail, email, archive, video, text.

is_private boolean

creative_status string

Allowed values: active, deleted.

html_code string

Only required when creative_type is ‘html’ or ‘email’.

width int

Only required when creative_type is ‘html’.

height int

Only required when creative_type is ‘html’.

email_from string

Only required when creative_type is ‘email’.

email_subject string

Only required when creative_type is ‘email’.

additional_offer_ids array[int]

is_apply_specific_affiliates boolean

resource_file object

View Object Details Hide Object Details

temp_url string

original_file_name string

html_files array[object]

View Object Details Hide Object Details

temp_url string

original_file_name string

html_assets array[object]

View Object Details Hide Object Details

content_type string

filename string

url string

file_size int

image_width int

image_height int

Payload Example

{
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "creative": {
    "network_offer_id": 0,
    "name": "",
    "creative_type": "image",
    "is_private": true,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [
      0
    ],
    "is_apply_specific_affiliates": true,
    "resource_file": {
      "temp_url": "",
      "original_file_name": ""
    },
    "html_files": [
      {
        "temp_url": "",
        "original_file_name": ""
      }
    ],
    "html_assets": [
      {
        "content_type": "",
        "filename": "",
        "url": "",
        "file_size": 0,
        "image_width": 0,
        "image_height": 0
      }
    ]
  }
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/creative/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "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
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Delete

DELETE /v1/networks/custom/creative/:settingId

Path Parameters

Parameter	Description
settingId	The ID of a network custom setting

Request Example

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/creative

Body Params

network_custom_scrub_rate_setting_ids array[int]

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

status string

Allowed values: active, inactive.

Payload Example

{
  "custom_creative_setting_ids": [
    0
  ],
  "status": "active"
}

Request Example

cURL

curl --request PATCH \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Docs: Custom Payout & Revenues

Mon, 01 Jan 0001 00:00:00 +0000

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

Request Example

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": 1,
    "network_id": 1,
    "is_apply_all_affiliates": true,
    "network_affiliate_ids": null,
    "network_offer_id": 2,
    "name": "Example Custom Setting",
    "network_offer_payout_revenue_id": 0,
    "description": "Example of a custom setting that applies on the base conversion, to all affiliates but specific to one offer URL",
    "custom_setting_status": "active",
    "is_custom_payout_enabled": true,
    "payout_amount": 3,
    "payout_percentage": 0,
    "payout_type": "cpa",
    "is_custom_revenue_enabled": true,
    "revenue_amount": 2,
    "revenue_percentage": 0,
    "revenue_type": "rpa",
    "is_postback_disabled": false,
    "date_valid_from": "",
    "date_valid_to": "",
    "public_description": "Public Description Visible to partners",
    "is_apply_specific_offer_urls": true,
    "currency_id": "USD",
    "network_offer_url_ids": [
        1
    ],
    "time_created": 1683066721,
    "time_saved": 1683066721,
    "relationship": {
      "affiliates": {
        "total": 0,
        "entries": []
      },
      "offer": {
        "network_offer_id": 2,
        "network_id": 1,
        "network_advertiser_id": 13,
        "network_offer_group_id": 5,
        "name": "Custom Setting Offer",
        "offer_status": "active",
        "network_tracking_domain_id": 1,
        "visibility": "public",
        "currency_id": "USD"
      },
      "payout_revenue": {
        "network_offer_payout_revenue_id": 2,
        "network_id": 1,
        "network_offer_id": 2,
        "entry_name": "",
        "payout_type": "cpa",
        "payout_amount": 0.8,
        "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": 1683039591,
        "global_advertiser_event_id": 0,
        "is_must_approve_conversion": false,
        "is_allow_duplicate_conversion": true,
        "is_email_attribution_default_event": false
      }
    }
  }]
}

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

Request Example

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": 1,
  "network_id": 1,
  "is_apply_all_affiliates": true,
  "network_affiliate_ids": null,
  "network_offer_id": 2,
  "name": "Example Custom Setting",
  "network_offer_payout_revenue_id": 0,
  "description": "Applies to base conversion, to all affiliates but specific to an offer URL",
  "custom_setting_status": "active",
  "is_custom_payout_enabled": true,
  "payout_amount": 3,
  "payout_percentage": 0,
  "payout_type": "cpa",
  "is_custom_revenue_enabled": true,
  "revenue_amount": 2,
  "revenue_percentage": 0,
  "revenue_type": "rpa",
  "is_postback_disabled": false,
  "date_valid_from": "",
  "date_valid_to": "",
  "public_description": "",
  "is_apply_specific_offer_urls": true,
  "currency_id": "USD",
  "network_offer_url_ids": [
    1
  ],
  "time_created": 1683066721,
  "time_saved": 1683066721,
  "relationship": {
    "affiliates": {
      "total": 0,
      "entries": []
    },
    "offer": {
      "network_offer_id": 2,
      "network_id": 1,
      "network_advertiser_id": 13,
      "network_offer_group_id": 5,
      "name": "Custom Setting Test",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    },
    "payout_revenue": {
      "network_offer_payout_revenue_id": 2,
      "network_id": 1,
      "network_offer_id": 2,
      "entry_name": "",
      "payout_type": "cpa",
      "payout_amount": 0.8,
      "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": 1683039591,
      "global_advertiser_event_id": 0,
      "is_must_approve_conversion": false,
      "is_allow_duplicate_conversion": true,
      "is_email_attribution_default_event": false
    }
  }
}

Create

POST /v1/networks/custom/payoutrevenue

Body Params

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. (aka Event_Id)

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

An optional description that will only be visible for network users.

public_description string

An optional description that will be visible to affiliates. Note that if the custom payout revenue completely overrides the base payout revenue settings (meaning that it isn’t regulated by dates, targeting or variables rules) then it will not be seen as a “custom payout” setting for the affiliate and the public description will not be visible.

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_amount double

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

payout_percentage int

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

payout_type string

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

revenue_amount double

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

revenue_percentage int

Only relevant for a revenue_type expressed on percentage (rps, rpa_rps)

revenue_type string

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

is_postback_disabled boolean

Determines whether partner postbacks will fire when this custom setting kicks in

date_valid_from string

Optional date before which the custom setting will not apply

date_valid_to string

Optional date after which the custom setting will not apply

is_apply_specific_offer_urls boolean

Optionally specify a list of offer URL ids on which this custom setting applies

network_offer_url_ids int array

Only relevant if is_apply_specific_offer_urls is true

ruleset object

List of rules for the payout/revenue. See the ruleset object.

variables object array

Required for SKU/price per product offers

View Object Details Hide Object Details

variable string

When creating a custom setting for SKU/price per product offers you will need to use the variable sku. To read more about SKU/ price per product offers and how they work click here.

variable_value string

comparison_method string

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

Payload Example

The custom payout revenue setting created by the payload only applies to a single affiliate, over a specific period of time on the base covnersion and only kicks in for traffic coming from the US with a sub1=google.

{
    "network_offer_id": 72,
    "network_offer_payout_revenue_id": 0,
    "name": "Custom Setting Name",
    "custom_setting_status": "active",
    "date_valid_from": "2021-05-01",
    "date_valid_to": "2021-05-31",
    "is_custom_revenue_enabled": true,
    "revenue_type": "rpa",
    "revenue_amount": 2,
    "revenue_percentage": null,
    "is_custom_payout_enabled": true,
    "payout_type": "cpa",
    "payout_amount": 1,
    "payout_percentage": null,
    "is_apply_all_affiliates": false,
    "is_postback_disabled": false,
    "is_apply_specific_offer_urls": false,
    "network_affiliate_ids": [
        7
    ],
    "variables": [
        {
            "variable_value": "google",
            "variable": "sub1",
            "comparison_method": "exact_match"
        }
    ],
    "ruleset": {
        "countries": [
            {
                "country_id": 227,
                "match_type": "exact",
                "targeting_type": "include"
            }
        ]
    }
}

Request Example

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": 4,
    "network_id": 1,
    "is_apply_all_affiliates": false,
    "network_affiliate_ids": [
        7
    ],
    "network_offer_id": 72,
    "name": "Custom Setting Name",
    "network_offer_payout_revenue_id": 0,
    "description": "",
    "custom_setting_status": "active",
    "is_custom_payout_enabled": true,
    "payout_amount": 1,
    "payout_percentage": 0,
    "payout_type": "cpa",
    "is_custom_revenue_enabled": true,
    "revenue_amount": 2,
    "revenue_percentage": 0,
    "revenue_type": "rpa",
    "is_postback_disabled": false,
    "date_valid_from": "2021-05-01",
    "date_valid_to": "2021-05-31",
    "public_description": "",
    "is_apply_specific_offer_urls": false,
    "network_offer_url_ids": null,
    "time_created": 1683067514,
    "time_saved": 1683067514,
    "relationship": {
        "affiliates": {
            "total": 1,
            "entries": [
                {
                    "network_affiliate_id": 7,
                    "network_id": 1,
                    "name": "Partner Inc.",
                    "account_status": "active",
                    "network_employee_id": 1,
                    "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": 1683039591,
                    "time_saved": 1683039591,
                    "referrer_id": 0
                }
            ]
        },
        "offer": {
            "network_offer_id": 72,
            "network_id": 1,
            "network_advertiser_id": 39,
            "network_offer_group_id": 0,
            "name": "Candy Crush Example",
            "offer_status": "pending",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        },
        "payout_revenue": {
            "network_offer_payout_revenue_id": 72,
            "network_id": 1,
            "network_offer_id": 72,
            "entry_name": "",
            "payout_type": "cpa",
            "payout_amount": 0.8,
            "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": 1683039591,
            "global_advertiser_event_id": 0,
            "is_must_approve_conversion": false,
            "is_allow_duplicate_conversion": true,
            "is_email_attribution_default_event": false
        },
        "currency_id": "USD"
    }
}

Update

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

Body Params

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

An optional description that will only be visible for network users.

public_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

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

payout_percentage int

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

payout_type string

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

revenue_amount double

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

revenue_percentage int

Only relevant for a revenue_type expressed on percentage (rps, rpa_rps)

revenue_type string

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

is_postback_disabled boolean

Determines whether partner postbacks will fire when this custom setting kicks in

date_valid_from string

Optional date before which the custom setting will not apply

date_valid_to string

Optional date after which the custom setting will not apply

is_apply_specific_offer_urls boolean

Optionally specify a list of offer URL ids on which this custom setting applies

network_offer_url_ids int array

Only relevant if is_apply_specific_offer_urls is true

ruleset object

List of rules for the payout/revenue. See the ruleset object.

variables object array

Required for SKU/price per product offers

View Object Details Hide Object Details

variable string

When creating a custom setting for SKU/price per product offers you will need to use the variable sku. To read more about SKU/ price per product offers and how they work click here.

variable_value string

comparison_method string

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

Payload Example

This will update a custom payout revenue setting that applies to all affiliates, on all traffic coming from iOS devices with a sub1=google.

{
    "network_custom_payout_revenue_setting_id": 795,
    "network_id": 1,
    "name": "Updated Setting Name",
    "description": "",
    "public_description": "",
    "network_offer_id": 95,
    "network_offer_payout_revenue_id": 196,
    "custom_setting_status": "active",
    "is_custom_payout_enabled": true,
    "payout_amount": null,
    "payout_percentage": 20,
    "payout_type": "cps",
    "is_custom_revenue_enabled": true,
    "revenue_amount": null,
    "revenue_percentage": 30,
    "revenue_type": "rps",
    "is_postback_disabled": false,
    "is_apply_all_affiliates": true,
    "is_apply_specific_offer_urls": false,
    "network_affiliate_ids": [],
    "date_valid_from": "",
    "date_valid_to": "",
    "ruleset": {
        "platforms": [
            {
                "platform_id": 2,
                "match_type": "exact",
                "targeting_type": "include"
            }
        ]
    },
    "variables": [
        {
            "variable_value": "google",
            "variable": "sub1",
            "comparison_method": "exact_match"
        }
    ],
    "currency_id": "USD"
}

Request Example

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": 795,
    "network_id": 1,
    "is_apply_all_affiliates": true,
    "network_affiliate_ids": null,
    "network_offer_id": 95,
    "name": "Updated Setting Name",
    "network_offer_payout_revenue_id": 196,
    "description": "",
    "public_description": "",
    "custom_setting_status": "active",
    "is_custom_payout_enabled": true,
    "payout_amount": 0,
    "payout_percentage": 20,
    "payout_type": "cps",
    "is_custom_revenue_enabled": true,
    "revenue_amount": 0,
    "revenue_percentage": 30,
    "revenue_type": "rps",
    "is_postback_disabled": false,
    "date_valid_from": "",
    "date_valid_to": "",
    "is_apply_specific_offer_urls": false,
    "network_offer_url_ids": null,
    "time_created": 1621961782,
    "time_saved": 1621962574,
    "relationship": {
        "affiliates": {
            "total": 0,
            "entries": []
        },
        "offer": {
            "network_offer_id": 95,
            "network_id": 1,
            "network_advertiser_id": 1,
            "network_offer_group_id": 0,
            "name": "Offer Name",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "require_approval",
            "currency_id": "USD"
        },
        "payout_revenue": {
            "network_offer_payout_revenue_id": 196,
            "network_id": 1,
            "network_offer_id": 95,
            "entry_name": "additional event 1",
            "payout_type": "null_value",
            "payout_amount": 0,
            "payout_percentage": 0,
            "revenue_type": "rpa",
            "revenue_amount": 1,
            "revenue_percentage": 0,
            "is_default": false,
            "is_private": true,
            "is_postback_disabled": true,
            "is_enforce_caps": false,
            "time_created": 1512498727,
            "global_advertiser_event_id": 0,
            "is_must_approve_conversion": false,
            "is_allow_duplicate_conversion": true,
            "is_email_attribution_default_event": false
        },
        "currency_id": "USD"
    }
}

Delete

DELETE /v1/networks/custom/payoutrevenue/:settingId

Path Parameters

Parameter	Description
settingId	The ID of a network custom setting

Request Example

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

Body Params

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.

View Object Details Hide Object Details

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

Payload Example

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

Request Example

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
}

Docs: Custom Scrub Rates (Throttle)

Mon, 01 Jan 0001 00:00:00 +0000

Find Custom Scrub Rate (Throttle) Settings

POST /v1/networks/custom/scrubratetable

This endpoint allows to fetch custom scrub rate (throttle) settings. Different filters can be used to narrow down the set of settings returned by the endpoint. You can, for example, use the filters to return only the settings associated with a specific affiliate ID.

Note that this endpoint does not return every detail of each custom scrub rate (throttle) setting. For example it will not return the specific variables associate with a setting (if specified). To get those, use the Find by ID endpoint documented below.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

Search terms are optional but can be used to look for specific words.

View Object Details Hide Object Details

search_type string

The name of the field used for search. Can be name, offer or affiliate

value string

The value to search.

filters object

Filters are also completely optional but are usually used to narrow down the set of settings returned. They can be used individually or combined in a single request.

View Object Details Hide Object Details

custom_setting_status string

Filter on the status of the custom scrub rate (throttle) setting. Possible values are active or inactive

network_affiliate_ids int array

Return only the settings associated with the specified affiliate IDs.

network_offer_ids int array

Return only the settings associated with the specified offer IDs.

scrub_rate_status string

Filter on how the setting affects the conversions it targets. Possible values are pending and rejected

Request Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/custom/scrubratetable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Find all active custom scrub rate (throttle) settings

{
  "search_terms": [],
  "filters":
  {
    "custom_setting_status": "active"
  }
}

Example 2 : Find all active custom scrub rate (throttle) settings that affect affiliate ID 7 and that contain the word “summer”

{
  "search_terms":
  [
    {
      "search_type": "name",
      "value": "summer"
    }
  ],
  "filters":
  {
    "custom_setting_status": "active",
    "network_affiliate_ids": [ 7 ]
  }
}

Response

{
  "custom_scrub_rate_settings":
  [
    {
      "network_custom_scrub_rate_setting_id": 4,
      "network_id": 1,
      "network_affiliate_id": 7,
      "network_offer_id": 8,
      "custom_setting_status": "active",
      "name": "Custom Scrub Example",
      "scrub_rate_status": "pending",
      "scrub_rate_percentage": 20,
      "time_created": 1684245710,
      "time_saved": 1684245752,
      "relationship":
      {
        "affiliate":
        {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "Example Affiliate Inc.",
          "account_status": "active"
        },
        "offer":
        {
          "network_offer_id": 8,
          "network_id": 1,
          "network_advertiser_id": 13,
          "network_offer_group_id": 0,
          "name": "Example offer with custom scrub",
          "offer_status": "active",
          "network_tracking_domain_id": 1,
          "visibility": "public",
          "currency_id": "USD"
        },
        "ruleset":
        {
          "network_id": 1,
          "network_ruleset_id": 71,
          "time_created": 1684245752,
          "time_saved": 1684245752,
          "platforms": [],
          "device_types": [],
          "os_versions": [],
          "browsers": [],
          "languages": [],
          "countries": [],
          "regions": [],
          "cities": [],
          "dmas": [],
          "mobile_carriers": [],
          "connection_types": [],
          "ips": [],
          "is_block_proxy": false,
          "is_use_day_parting": false,
          "day_parting_apply_to": "user_timezone",
          "day_parting_timezone_id": 0,
          "days_parting": [ ],
          "isps": [],
          "brands": [],
          "postal_codes": []
        }
      }
    }
  ],
  "paging":
  {
    "page": 1,
    "page_size": 100,
    "total_count": 1
  }
}

Find By ID

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

Path Parameters

Parameter	Description
settingId	The ID of the custom scrub rate (throttle) setting

Relationships

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

Value	Description
variables	Include the variables the setting affects (if any)
targeting	Includes the setting’s sepcific targeting settings (if any)

Request Example

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_scrub_rate_setting_id": 4,
  "network_id": 1,
  "network_affiliate_id": 7,
  "network_offer_id": 8,
  "custom_setting_status": "active",
  "name": "Example Custom Scrub Setting",
  "scrub_rate_status": "pending",
  "scrub_rate_percentage": 25,
  "time_created": 1684245710,
  "time_saved": 1684261331,
  "relationship":
  {
    "affiliate":
    {
      "network_affiliate_id": 7,
      "network_id": 1,
      "name": "Example Affiliate Inc.",
      "account_status": "active",
      "network_employee_id": 1,
      "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": 1683039591,
      "time_saved": 1683750489,
      "referrer_id": 0
    },
    "offer":
    {
      "network_offer_id": 8,
      "network_id": 1,
      "network_advertiser_id": 13,
      "network_offer_group_id": 0,
      "name": "Example offer with scrub setting",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    },
    "ruleset":
    {
      "network_id": 1,
      "network_ruleset_id": 72,
      "time_created": 1684261331,
      "time_saved": 1684261331,
      "platforms": [],
      "device_types": [],
      "os_versions": [],
      "browsers": [],
      "languages": [],
      "countries":
      [
        {
          "network_id": 1,
          "network_targeting_country_id": 17,
          "country_id": 227,
          "label": "United States",
          "country_code": "US",
          "targeting_type": "include",
          "match_type": "exact"
        }
      ],
      "regions": [],
      "cities": [],
      "dmas": [],
      "mobile_carriers": [],
      "connection_types": [],
      "ips": [],
      "is_block_proxy": false,
      "is_use_day_parting": false,
      "day_parting_apply_to": "user_timezone",
      "day_parting_timezone_id": 0,
      "days_parting": [],
      "isps": [],
      "brands": [],
      "postal_codes": []
    },
    "variables":
    {
      "total": 1,
      "entries":
      [
        {
          "network_custom_scrub_rate_setting_variable_id": 4,
          "network_custom_scrub_rate_setting_id": 4,
          "comparison_method": "exact_match",
          "variable": "sub1",
          "variable_value": "bad_source"
        }
      ]
    }
  }
}

Create

Create a custom scrub rate (throttle) setting associated with a partner / offer couple.

POST /v1/networks/custom/scrubrate

Body Params

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 or pending

scrub_rate_percentage int

The scrub rate percentage (this is the percentage of conversion that will be affected by the setting). Note that if you specify e.g. 25%, it means that each conversion has a 25% chance of being scrubbed, not necessarily that exactly 25% will be scrubbed (although with a big enough quantity it will be the case).

variables object array

Optional list of variables that must match for the setting to apply

View Object Details Hide Object Details

comparison_method string

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

variable string

The scrub rate variable. Can be sub1, sub2, sub3, sub4, sub5 and source_id

variable_value string

The value to use for comparison.

ruleset object

Optional additional targeting rules for determining when the setting is used. See the ruleset object.

Payload Example

{
  "network_custom_scrub_rate_setting_id": 4,
  "network_id": 1,
  "network_affiliate_id": 7,
  "network_offer_id": 8,
  "custom_setting_status": "active",
  "name": "Custom Scrub Setting",
  "scrub_rate_status": "pending",
  "scrub_rate_percentage": 25,
  "time_created": 1684245710,
  "time_saved": 1684261331,
  "variables":
  [
    {
      "network_custom_scrub_rate_setting_variable_id": 4,
      "network_custom_scrub_rate_setting_id": 4,
      "comparison_method": "exact_match",
      "variable": "sub1",
      "variable_value": "bad_source"
    }
  ]
}

Request Example

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": 4,
  "network_id": 1,
  "network_affiliate_id": 7,
  "network_offer_id": 8,
  "custom_setting_status": "active",
  "name": "Custom Scrub Rate Exmple",
  "scrub_rate_status": "pending",
  "scrub_rate_percentage": 25,
  "time_created": 1684245710,
  "time_saved": 1684263714,
  "relationship":
  {
    "affiliate":
    {
      "network_affiliate_id": 7,
      "network_id": 1,
      "name": "Example Affiliate Inc.",
      "account_status": "active",
      "network_employee_id": 1,
      "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": 1683039591,
      "time_saved": 1683750489,
      "referrer_id": 0
    },
    "offer":
    {
      "network_offer_id": 8,
      "network_id": 1,
      "network_advertiser_id": 13,
      "network_offer_group_id": 0,
      "name": "Example Offer With Scrub",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    }
  }
}

Update

Update an existing custom scrub rate (throttle) setting.

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

Body Params

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 or pending

scrub_rate_percentage int

variables object array

Optional list of variables that must match for the setting to apply

View Object Details Hide Object Details

comparison_method string

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

variable string

The scrub rate variable. Can be sub1, sub2, sub3, sub4, sub5 and source_id

variable_value string

The value to use for comparison.

ruleset object

Optional additional targeting rules for determining when the setting is used. See the ruleset object.

Payload Example

{
    "network_custom_scrub_rate_setting_id": 4,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 8,
    "custom_setting_status": "active",
    "name": "Updated Custom Scrub Setting",
    "scrub_rate_status": "pending",
    "scrub_rate_percentage": 30,
    "time_created": 1684245710,
    "time_saved": 1684261331,
    "variables":
    [
        {
            "network_custom_scrub_rate_setting_variable_id": 4,
            "network_custom_scrub_rate_setting_id": 4,
            "comparison_method": "exact_match",
            "variable": "sub1",
            "variable_value": "updated_bad_source"
        }
    ]
}

Request Example

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": 4,
  "network_id": 1,
  "network_affiliate_id": 7,
  "network_offer_id": 8,
  "custom_setting_status": "active",
  "name": "Custom Scrub Rate Exmple",
  "scrub_rate_status": "pending",
  "scrub_rate_percentage": 25,
  "time_created": 1684245710,
  "time_saved": 1684263714,
  "relationship":
  {
    "affiliate":
    {
      "network_affiliate_id": 7,
      "network_id": 1,
      "name": "Example Affiliate Inc.",
      "account_status": "active",
      "network_employee_id": 1,
      "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": 1683039591,
      "time_saved": 1683750489,
      "referrer_id": 0
    },
    "offer":
    {
      "network_offer_id": 8,
      "network_id": 1,
      "network_advertiser_id": 13,
      "network_offer_group_id": 0,
      "name": "Example Offer With Scrub",
      "offer_status": "active",
      "network_tracking_domain_id": 1,
      "visibility": "public",
      "currency_id": "USD"
    }
  }
}

Delete

Delete an existing custom scrub rate (throttle) setting.

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

Path Parameters

Parameter	Description
settingId	The ID of a network custom setting

Request Example

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
}

Docs: Encoding / Decoding

Mon, 01 Jan 0001 00:00:00 +0000

The numeric IDs of certain resources are sometimes encoded on the Everflow platform. For example, when generating a tracking link for offer ID 1 / partner ID 1 the tracking link will look like so : https://YOUR-TRACKING-DOMAIN.com/28KL6/2CTPL/. In this URL, the 28KL6 portion of the URL identifies “partner ID 1” whereas 2CTPL identifies “offer ID 1”.

It’s normally not necessary to encode / decode the IDs yourself as the values will be encoded automatically when generating tracking links, signup links, etc.

The following endpoints are made available in case you need to encode or decode the values for different purposes (internal processes that depend on them, etc.).

There are 7 different situations in which numeric IDs are encoded in Everflow :

tracking_link_affiliate : the partner ID in the context of a tracking link.
tracking_link_offer : the offer ID in the context of a tracking link.
smart_link_affiliate : the partner ID in the context of a smartlink.
smart_link_smart_link : the smart link ID in the context of a smartlink tracking link.
signup_affiliate_employee : the employee ID in the context of a partner signup. The encoded employee ID is used for the account manager.
signup_advertiser_employee : the employee ID in the context of an advertiser signup. The encoded employee ID is used for the account manager.
signup_affiliate_affiliate : the partner ID in the context of a partner signup. The encoded partner ID is used for the “referrer”.

Encoding

POST /v1/networks/encode

This endpoint allows you to encode numeric IDs for the different situations outlined above.

Body Params

type string

The situation for which you are encoding the IDs. Values are tracking_link_affiliate, tracking_link_offer, smart_link_affiliate, smart_link_smart_link, signup_affiliate_employee, signup_advertiser_employee, signup_affiliate_affiliate

ids int array

The IDs you want to encode

Payload Example

{
    "type": "tracking_link_offer",
	"ids": [1, 2, 3]
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/encode' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Response

{
  "values": [
    {
      "decoded": 1,
      "encoded": "2CTPL"
    },
    {
      "decoded": 2,
      "encoded": "3QQG7"
    },
    {
      "decoded": 3,
      "encoded": "55M6S"
    }
  ]
}

Decoding

POST /v1/networks/decode

This endpoint allows you to decode numeric IDs that have been encoded in the Everflow platform.

Values that cannot be decoded will return 0.

Body Params

type string

The situation in which the IDs were encoded. Values are tracking_link_affiliate, tracking_link_offer, smart_link_affiliate, smart_link_smart_link, signup_affiliate_employee, signup_advertiser_employee, signup_affiliate_affiliate

ids string array

The encoded IDs you want to decode

Payload Example

{
    "type": "tracking_link_offer",
	"ids": ["2CTPL", "3QQG7", "55M6S"]
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/decode' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Response

{
  "values": [
    {
      "decoded": 1,
      "encoded": "2CTPL"
    },
    {
      "decoded": 2,
      "encoded": "3QQG7"
    },
    {
      "decoded": 3,
      "encoded": "55M6S"
    }
  ]
}

Docs: Imports

Mon, 01 Jan 0001 00:00:00 +0000

Conversion Operations via CSV Upload

POST /v1/networks/reporting/upload/conversions

Conversions can be generated or updated in Everflow by uploading a CSV file. The format of the CSV file is determined by the operation that must be done and all formats are documented on the Everflow helpdesk.

When done via the API, there are 2 steps involved :

Upload the CSV file
Create the operation itself using the CSV file uploaded

The first step of uploading the CSV file is documented here. The call will result in the creation of a temporary asset with an url that looks like :

https://usercontent.everflowclient.io/<network_id>/temp/<32_characters_guid>

This is the temp_url that must be used in the creation of the operation (second step) documented here.

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/reporting/upload/conversions' \
--header 'Content-Type: application/json' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--data '<INSERT PAYLOAD>'

Request

{
    "file": {
        "temp_url": "https://usercontent.everflowclient.io/<network_id>/temp/<32_characters_guid>",
        "original_file_name": "<filename>.csv"
    }
}

Docs: Invoices

Mon, 01 Jan 0001 00:00:00 +0000

Find Partner Invoices

POST /v1/networks/billings/affiliates/invoicestable

This endpoint allows to fetch partner invoices. Different filters can be used to narrow down the set of invoices that will be returned by the endpoint. You can, for example, use the filters to only return the unpaid invoices for a specific affiliate ID.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

Search terms are optional but can be used to look for specific words.

View Object Details Hide Object Details

search_type string

The name of the field used for search. On this endpoint, it can only ever be name. Searching by name will actually search the invoice ID, the partner ID as well as the partner name.

value string

The value to search.

filters object

Filters are also completely optional but are usually used to narrow down the set of invoices returned. They can be used individually or combined in a single request.

View Object Details Hide Object Details

network_affiliate_ids int array

One or multiple partner IDs for which the invoices will be returned.

network_affiliate_invoice_ids int array

Return a specific set of invoice IDs.

account_manager_ids int array

One or multiple account manager IDs for which the invoices will be returned.

min_start_time string

Only return invoices with a start date greater or equal to this value. Takes a date in the YYYY-MM-DD format

max_end_time string

Only return invoices with an end date smaller or equal to this value. Takes a date in the YYYY-MM-DD format

min_balance decimal number

Only return invoices with an invoice balance grater than this value.

max_balance decimal number

Only return invoices with an invoice balance smaller than this value.

affiliate_invoice_status string

Only return invoices with a status equal to this value. Can only be paid, unpaid or deleted

is_hidden_affiliate string

Filters based on whether the invoice is visible to the partner or not. Can be visible or hidden

payment_terms int array

Only return invoices for which the payment terms is a number of days contained in this array.

Request Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/billings/affiliates/invoicestable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Find all invoices for partners named “Google” where the invoice period finished before April 4th 2020 :

{
    "search_terms":
    [
        {
			"search_type": "name",
			"value": "Google"
		}
    ],
    "filters":
    {
        "max_end_time": "2020-04-01"
    }
}

Example 2 : Find all unpaid invoices for affiliate ID 8080 :

{
    "search_terms": [],
    "filters":
    {
        "affiliate_invoice_status": "unpaid",
        "network_affiliate_ids":
        [
            8080
        ]
    }
}

Response

{
	"invoices": [
		{
			"network_affiliate_invoice_id": 368,
			"network_id": 1,
			"network_affiliate_id": 27,
			"network_affiliate_name": "Example Affiliate",
			"affiliate_invoice_status": "paid",
			"start_time": "2019-12-01 00:00:00",
			"end_time": "2020-03-06 23:59:59",
			"timezone_id": 55,
			"balance": 0,
			"paid": 200,
			"billed": 200,
			"currency_id": "USD",
			"payment_terms": 20,
			"is_hidden_affiliate": false,
			"public_notes": "",
			"internal_notes": "",
			"payment_type": "masspay",
			"time_created": 1583541215,
			"time_saved": 1599140043
		}
	],
	"paging": {
		"page": 1,
		"page_size": 50,
		"total_count": 1
	}
}

Partner Invoices Summary

POST /v1/networks/billings/affiliates/summary

This endpoint is very similar to the endpoint documented above (“Find Partner Invoices”). The filters are exactly the same, but instead of returning multiple invoices, the endpoint will simply return the “summary” (billed amount, balance, etc.) of the invoices involved.

Body Params

search_terms object array

Search terms are optional but can be used to look for specific words.

View Object Details Hide Object Details

search_type string

The name of the field used for search. On this endpoint, it can only ever be name. Searching by name will actually search the invoice ID, the partner ID as well as the partner name.

value string

The value to search.

filters object

Filters are also completely optional but are usually used to narrow down the set of invoices returned. They can be used individually or combined in a single request.

View Object Details Hide Object Details

network_affiliate_ids int array

One or multiple partner IDs for which the invoices will be returned.

network_affiliate_invoice_ids int array

Return a specific set of invoice IDs.

account_manager_ids int array

One or multiple account manager IDs for which the invoices will be returned.

min_start_time string

Only return invoices with a start date greater or equal to this value. Takes a date in the YYYY-MM-DD format

max_end_time string

Only return invoices with an end date smaller or equal to this value. Takes a date in the YYYY-MM-DD format

min_balance decimal number

Only return invoices with an invoice balance grater than this value.

max_balance decimal number

Only return invoices with an invoice balance smaller than this value.

affiliate_invoice_status string

Only return invoices with a status equal to this value. Can only be paid, unpaid or deleted

is_hidden_affiliate string

Filters based on whether the invoice is visible to the partner or not. Can be visible or hidden

payment_terms int array

Only return invoices for which the payment terms is a number of days contained in this array.

Request Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/billings/affiliates/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Find the summary for invoices for partners named “Google” where the invoice period finished before April 4th 2020 :

{
    "search_terms":
    [
        {
			"search_type": "name",
			"value": "Google"
		}
    ],
    "filters":
    {
        "max_end_time": "2020-04-01"
    }
}

Example 2 : Find invoice summary for unpaid invoices for affiliate ID 8080 :

{
    "search_terms": [],
    "filters":
    {
        "affiliate_invoice_status": "unpaid",
        "network_affiliate_ids":
        [
            8080
        ]
    }
}

Response

{
	"total_count": 1,
	"balance": 23,
	"billed": 23,
	"paid": 0
}

Find Partner Invoice by ID

GET /v1/networks/billings/affiliates/invoices/:invoiceId

This endpoint allows you fetch the details of a single partner invoice.

Path Parameters

Parameter	Description
invoiceId	The ID of the partner invoice you want to fetch

Request Example

cURL

curl --request GET '/v1/networks/billings/affiliates/invoices/553' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"network_affiliate_invoice_id": 553,
	"network_id": 1,
	"network_affiliate_id": 27,
	"status": "unpaid",
	"start_time": "2020-09-03 00:00:00",
	"end_time": "2020-09-09 23:59:59",
	"public_notes": "",
	"internal_notes": "",
	"timezone_id": 80,
	"balance": 72.95,
	"currency_id": "USD",
	"is_hidden_affiliate": false,
	"payment_terms": 15,
	"time_created": 1599711451,
	"time_saved": 1626114580,
	"relationship": {
		"details": [
			{
				"network_affiliate_invoice_detail_id": 240,
				"network_affiliate_invoice_id": 553,
				"network_offer_id": 3,
				"network_offer_name": "Example Offer Name",
				"amount": 72.95,
				"invoice_currency_amount": 72.95,
				"currency_id": "USD",
				"notes": "",
				"quantity": 1,
				"time_created": 0,
				"time_saved": 0,
				"referral_history_id": 0
			}
		]
	},
	"details": null,
	"extra_periods": null
}

Create Partner Invoice

POST /v1/networks/billings/affiliates/invoices

This endpoint allows you to create a partner invoice via the API. Note that creating an invoice (whether marked as paid or unpaid) will never in itself trigger a payment.

Body Params

network_affiliate_id int

The ID of the partner that will be invoiced.

status string

Status of the invoice that will be created. Can be paid, unpaid or deleted

start_time string

Invoice start date in the YYYY-MM-DD format

end_time string

Invoice end date in the YYYY-MM-DD format

public_notes string

Notes that will be visible to both the network employees and the invoiced partner.

internal_notes string

Notes that will be visible to network employees but not the invoiced partner.

is_hidden_affiliate bool

Determines whether the invoice is visible to the partner or not.

payment_terms int

Number of days for the affiliate payment term (i.e. pass 20 for NET 20)

Request Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/billings/affiliates/invoices' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example body :

{
    "network_affiliate_id": 7,
    "start_time": "2021-12-01",
    "end_time": "2021-12-20",
    "status": "unpaid",
    "is_hidden_affiliate": false,
    "payment_terms": 15,
    "public_notes": "public note visible to affiliate",
    "internal_notes": "internal note not visible to affiliate"
}

Docs: Labels

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/labels

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/labels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
  "labels": [
    {
      "label": "",
      "advertiser_ids": [
        0
      ],
      "affiliate_ids": [
        0
      ],
      "campaign_ids": [
        0
      ],
      "offer_ids": [
        0
      ],
      "offer_group_ids": [
        0
      ],
      "relationship": {
        "advertisers": [
          {
            "network_advertiser_id": 0,
            "network_id": 0,
            "name": "",
            "account_status": "active"
          }
        ],
        "affiliates": [
          {
            "network_affiliate_id": 0,
            "network_id": 0,
            "name": "",
            "account_status": "active"
          }
        ],
        "campaigns": [
          {
            "network_campaign_id": 0,
            "network_id": 0,
            "campaign_name": "",
            "campaign_status": "active"
          }
        ],
        "offers": [
          {
            "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": ""
          }
        ],
        "offer_groups": [
          {
            "network_offer_group_id": 0,
            "network_id": 0,
            "network_advertiser_id": 0,
            "name": "",
            "offer_group_status": "active",
            "offer_count": 0
          }
        ]
      }
    }
  ]
}

Find By Label

GET /v1/networks/labels/:label

Path Parameters

Parameter	Description
label	The label you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/labels/<INSERT LABEL>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

 {
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ],
  "relationship": {
    "advertisers": [
      {
        "network_advertiser_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active"
      }
    ],
    "affiliates": [
      {
        "network_affiliate_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active"
      }
    ],
    "campaigns": [
      {
        "network_campaign_id": 0,
        "network_id": 0,
        "campaign_name": "",
        "campaign_status": "active"
      }
    ],
    "offers": [
      {
        "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": ""
      }
    ],
    "offer_groups": [
      {
        "network_offer_group_id": 0,
        "network_id": 0,
        "network_advertiser_id": 0,
        "name": "",
        "offer_group_status": "active",
        "offer_count": 0
      }
    ]
  }
}

Create

POST /v1/networks/labels

Body Params

Note: At least one of advertiser_ids, affiliate_ids, campaign_ids, offer_ids, offer_group_ids, must have at least one entry.

label string

The label you want to add.

advertiser_ids array[int]

Which advertisers will have the label.

affiliate_ids array[int]

Which affiliates will have the label.

campaign_ids array[int]

Which campaigns will have the label.

offer_ids array[int]

Which offers will have the label.

offer_group_ids array[int]

Which offer groups will have the label.

Payload Example

{
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ]
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/labels' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Update

PUT /v1/networks/labels?old_label=:oldLabel

Path Parameters

Parameter	Description
oldLabel	The label to be updated (previous value)

Body Params

Note: At least one of advertiser_ids, affiliate_ids, campaign_ids, offer_ids, offer_group_ids, must have at least one entry.

label string

The label you want to add.

advertiser_ids array[int]

Which advertisers will have the label.

affiliate_ids array[int]

Which affiliates will have the label.

campaign_ids array[int]

Which campaigns will have the label.

offer_ids array[int]

Which offers will have the label.

offer_group_ids array[int]

Which offer groups will have the label.

Payload Example

{
  "label": "",
  "advertiser_ids": [
    0
  ],
  "affiliate_ids": [
    0
  ],
  "campaign_ids": [
    0
  ],
  "offer_ids": [
    0
  ],
  "offer_group_ids": [
    0
  ]
}

Request Example

cURL

curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/labels?old_label=<INSERT OLD LABEL>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
  "result": true
}

Delete

DELETE /v1/networks/labels?label=:label

Path Parameters

Parameter	Description
label	The label to be deleted

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/labels?label=<INSERT LABEL>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \

Response

{
  "result": true
}

Docs: Offers

Mon, 01 Jan 0001 00:00:00 +0000

Fetch Offers

POST /v1/networks/offerstable

This is the main endpoint to extract a list of offers from the API. It’s possible to filter the offers returned by this endpoint using 2 different methods (which can be combined) :

Search Terms : equivalent to a text search (e.g. find offers with a name that contains the word “phone”)
Query Filters : structured filters on predefined fields (e.g. find offers that target the Android platform)

Please note that the destination_url in the response is the offer’s default landing page URL

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

This is a text search on the name or advertiser of the offer

View Object Details Hide Object Details

search_type string

The name of the field used for search. Can be one of the following values: name, encoded_value or advertiser_name. The value name will also allow searching by ID. The encoded_value will only work with an exact match and will not detect partial matches.

value string

The value to search.

filters object

Structured filters

View Object Details Hide Object Details

network_advertiser_ids int array

ID of the advertiser associated with the offer.

network_offer_group_id int

ID of the offer group associated with the offer.

network_category_ids int array

ID of the category type associated with the offer.

offer_status string

Status of the offers. Can be one of the following values: active, paused, pending or deleted.

visibilities string array

Visibility type associated with the offer. From the following values: public, require_approval or private.

labels string array

Only include offers matching the specified labels.

business_unit_ids int array

Filter offers based on the specified business units.

account_manager_ids int array

Only include offers managed by the specified account managers.

sales_manager_ids int array

Only include offers managed by the specified sales managers.

network_tracking_domain_ids int array

Only include offers running traffic on the specified tracking domains.

network_channel_ids int array

ID of the channels associated with the offer.

revenue_types string array

Filter offers based on the specified revenue type.

payout_types string array

Filter offers based on the specified payout type.

country_ids int array

ID of the country

platforms_ids int array

ID of the platform

device_types_ids int array

ID of the device types

Relationships

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

Value	Description
visibility	Includes the offer’s visibility information
ruleset	Includes the offer’s targeting ruleset
tracking_domain	Includes the offer’s tracking domain
urls	Includes the offer URLs
affiliate_tier	Includes which affiliate tiers are involved
account_manager	Includes the offer’s account manager’s information
sales_manager	Includes the offer’s sale manager’s information
dmo	Indicates whether the offer is the default marketplace offer

Examples

The following examples are different variations of what you can pass as a payload in the following call :

cURL

curl --request POST 'https://api.eflow.team/v1/networks/offerstable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch the active offers

{
  "filters": {
    "offer_status": "active"
  }
}

To fetch, for example, the second page of 50 active offers and include the targeting information, you would run the following call :

curl --request POST 'https://api.eflow.team/v1/networks/offerstable?page=2&page_size=50&relationship=ruleset' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "offer_status": "active"
  }
}'

Example 2 : Fetch private CPA offers with a name that contains the word “Free”

{
  "filters": {
    "payout_types": [
      "cpa"
    ],
    "visibilities": [
      "private"
    ]
  },
  "search_terms": [
    {
      "search_type": "name",
      "value": "Free"
    }
  ]
}

Example 3: Fetch active offers that target phones and tablets. Note that this will include offers that target all devices (and not specifically phones or tablets)

{
  "filters": {
    "offer_status": "active",
    "device_type_ids": [
      2,
      3
    ]
  },
  "search_terms": []
}

Response

{
   "offers": [
      {
         "network_offer_id": 2,
         "network_id": 1,
         "network_advertiser_id": 13,
         "name": "Game Auto",
         "offer_status": "active",
         "thumbnail_url": "",
         "visibility": "public",
         "network_advertiser_name": "Kaori Thompson Inc.",
         "category": "Finance",
         "network_offer_group_id": 2,
         "time_created": 1623683450,
         "time_saved": 1623706863,
         "payout": "CPA: $0.800",
         "revenue": "RPA: $1.000",
         "today_revenue": "$0.00",
         "daily_conversion_cap": 25,
         "weekly_conversion_cap": 0,
         "monthly_conversion_cap": 50,
         "global_conversion_cap": 100,
         "daily_payout_cap": 0,
         "weekly_payout_cap": 0,
         "monthly_payout_cap": 0,
         "global_payout_cap": 0,
         "daily_revenue_cap": 0,
         "weekly_revenue_cap": 0,
         "monthly_revenue_cap": 0,
         "global_revenue_cap": 0,
         "daily_click_cap": 0,
         "weekly_click_cap": 0,
         "monthly_click_cap": 0,
         "global_click_cap": 0,
         "destination_url": "http://landing-page.com?aid={affiliate_id}&oid={offer_id}&tid={transaction_id}",
         "encoded_value": "3QQG7",
         "labels": null,
         "today_clicks": 0,
         "is_force_terms_and_conditions": false,
         "project_id": "",
         "channels": null,
         "relationship": {
           "remaining_caps": {
             "remaining_daily_payout_cap": -1000,
             "remaining_daily_revenue_cap": -1000,
             "remaining_daily_conversion_cap": 25,
             "remaining_daily_click_cap": -1000,
             "remaining_weekly_payout_cap": -1000,
             "remaining_weekly_revenue_cap": -1000,
             "remaining_weekly_conversion_cap": -1000,
             "remaining_weekly_click_cap": -1000,
             "remaining_monthly_payout_cap": -1000,
             "remaining_monthly_revenue_cap": -1000,
             "remaining_monthly_conversion_cap": 50,
             "remaining_monthly_click_cap": -1000,
             "remaining_global_payout_cap": -1000,
             "remaining_global_revenue_cap": -1000,
             "remaining_global_conversion_cap": 100,
             "remaining_global_click_cap": -1000
           },
           "ruleset": {
             "network_id": 1,
             "network_ruleset_id": 70,
             "time_created": 1623694632,
             "time_saved": 1623694795,
             "platforms": [],
             "device_types": [],
             "os_versions": [],
             "browsers": [],
             "languages": [],
             "countries": [],
             "regions": [],
             "cities": [],
             "dmas": [],
             "mobile_carriers": [],
             "connection_types": [],
             "ips": [],
             "is_block_proxy": false,
             "is_use_day_parting": false,
             "day_parting_apply_to": "null_value",
             "day_parting_timezone_id": 0,
             "days_parting": [],
             "isps": [],
             "brands": [],
             "postal_codes": [
               {
                 "network_id": 1,
                 "network_targeting_postal_code_id": 2,
                 "postal_code": "90210",
                 "label": "90210",
                 "targeting_type": "include",
                 "match_type": "exact"
               },
               {
                 "network_id": 1,
                 "network_targeting_postal_code_id": 3,
                 "postal_code": "90211",
                 "label": "90211",
                 "targeting_type": "include",
                 "match_type": "exact"
               }
             ]
           }
         },
         "optimized_thumbnail_url": "",
         "currency_id": "USD",
         "revenue_amount": 1,
         "payout_amount": 0.8,
         "today_revenue_amount": 0,
         "today_payout_amount": 0,
         "payout_type": "cpa",
         "revenue_type": "rpa"
       }
   ]
}

Find By ID

GET /v1/networks/offers/:offerId

This endpoint allows you fetch the details of a single offer.

Please note that the destination_url is the offer’s default landing page URL

Path Parameters

Parameter	Description
offerId	The ID of the offer you want to fetch

Relationships

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

Value	Description
advertiser	Includes the offer’s advertiser
offer_group	Includes the offer’s offer group, if applicable
visibility	Includes the offer’s visibility information
payout_revenue	Includes the offer’s payout revenue information
custom_cap_settings	Includes the offer’s cap settings
custom_scrub_rate_settings	Includes the offer’s throttle rate settings
custom_payout_revenue_settings	Includes the offer’s revenue & payout settings
custom_creative_settings	Includes the offer’s creative settings
redirects	Includes the offer’s redirects information
traffic_filters	Includes the traffic filters information
targeting	Includes the offer’s targeting information
files	Includes the offer’s files information
audits	Includes the offer’s audits information
source_name	Includes the source name information
urls	Includes the urls information
integrations	Includes the offer’s integrations information
campaigns	Includes the offer’s campaigns information
advertiser_global_events	Includes the advertiser’s global events information
offer_email	Includes the offer’s email information
offer_email_optout	Includes the offer’s email opt-out information
reporting	Includes the offer’s reporting for today

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/offers/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

 {
  "network_offer_id": 1,
  "network_id": 1,
  "network_advertiser_id": 13,
  "network_offer_group_id": 3,
  "name": "Offer Example",
  "thumbnail_url": "",
  "network_category_id": 1,
  "internal_notes": "",
  "destination_url": "http://everflowclient.io/test.php?aid={affiliate_id}&oid={offer_id}&tid={transaction_id}",
  "server_side_url": "",
  "is_view_through_enabled": false,
  "view_through_destination_url": "",
  "preview_url": "",
  "offer_status": "active",
  "currency_id": "USD",
  "caps_timezone_id": 0,
  "project_id": "",
  "date_live_until": "",
  "html_description": "",
  "is_using_explicit_terms_and_conditions": false,
  "terms_and_conditions": "",
  "is_force_terms_and_conditions": false,
  "is_caps_enabled": false,
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 0,
  "daily_payout_cap": 0,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 0,
  "global_click_cap": 0,
  "redirect_mode": "standard",
  "is_using_suppression_list": false,
  "suppression_list_id": 0,
  "is_must_approve_conversion": false,
  "is_allow_duplicate_conversion": true,
  "is_duplicate_filter_enabled": false,
  "duplicate_filter_targeting_action": "unknown",
  "network_tracking_domain_id": 1,
  "is_use_secure_link": false,
  "is_seo_friendly": false,
  "is_allow_deep_link": false,
  "is_session_tracking_enabled": false,
  "session_tracking_start_on": "null_value",
  "session_tracking_lifespan_hour": 0,
  "session_tracking_minimum_lifespan_second": 0,
  "is_view_through_session_tracking_enabled": false,
  "view_through_session_tracking_lifespan_minute": 0,
  "view_through_session_tracking_minimal_lifespan_second": 0,
  "is_block_already_converted": false,
  "already_converted_action": "unknown",
  "is_fail_traffic_enabled": false,
  "redirect_routing_method": "internal",
  "redirect_internal_routing_type": "priority",
  "visibility": "public",
  "time_created": 1594391076,
  "time_saved": 1594391076,
  "conversion_method": "server_postback",
  "is_whitelist_check_enabled": false,
  "is_use_scrub_rate": false,
  "scrub_rate_status": "null_value",
  "scrub_rate_percentage": 0,
  "session_definition": "cookie",
  "session_duration": 24,
  "app_identifier": "",
  "is_description_plain_text": false,
  "is_use_direct_linking": false,
  "is_email_attribution_enabled": false,
  "is_email_attribution_window_enabled": true,
  "email_attribution_window_minute": 1440,
  "email_attribution_window_type": "dynamic",
  "relationship": {
    "category": {
      "network_category_id": 1,
      "network_id": 1,
      "name": "Finance",
      "status": "active",
      "time_created": 1592409064,
      "time_saved": 1592409064
    },
    "labels": {
      "total": 0,
      "entries": []
    },
    "payout_revenue": {
      "total": 1,
      "entries": [
        {
          "network_offer_payout_revenue_id": 1,
          "network_id": 1,
          "network_offer_id": 1,
          "entry_name": "",
          "payout_type": "cpa",
          "payout_amount": 0.8,
          "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": 1594391076,
          "global_advertiser_event_id": 0,
          "is_must_approve_conversion": false,
          "is_allow_duplicate_conversion": true,
          "is_email_attribution_default_event": false
        }
      ]
    },
    "encoded_value": "2CTPL",
    "is_locked_currency": false,
    "channels": {
      "total": 0,
      "entries": []
    },
    "is_locked_caps_timezone": false,
    "requirement_kpis": {
      "total": 0,
      "entries": []
    },
    "requirement_tracking_parameters": {
      "total": 0,
      "entries": []
    }
  }
}

Create

POST /v1/networks/offers

While it is possible to create offers using this endpoint, it’s important to note that because of the nature of the offer object in Everflow, the payload that must be passed here is extremely complex. We unfortunately cannot possibly provide examples for all the configurations possible.

It is often much simpler to create a “template” offer manually in your Everflow account and then make use of the Copy endpoint and the Bulk Edit endpoint to change the properties that need to be updated.

Body Params

network_advertiser_id int

ID of the advertiser submitting the offer.

network_offer_group_id int

ID of the offer group associated with the offer.

name string

Displayed name of the offer.

thumbnail_url string

URL of the image thumbnail associated with the offer and visible to network and affiliates.

network_category_id int

ID of the category type associated with the offer.

internal_notes string

Notes on the offer for network employees. Not displayed to affiliates and advertisers.

destination_url string

URL of the final landing page associated with the offer, including additional macros if applicable.

server_side_url string

Server-side URL that will be asynchronously fired by Everflow following a click.

is_view_through_enabled boolean

Whether conversions can be generated from impressions (as opposed to being generated from clicks only).

view_through_destination_url string

URL of the final landing page associated with the offer when redirected from an impression (including additional macros if applicable). Only relevant if is_view_through_enabled is true.

preview_url string

URL of a preview of the offer landing page.

offer_status string

Status of the offer. Can be one of the following values: active, paused, pending or deleted.

currency_id string

Currency used to compute payouts, costs and revenues of the offer.

caps_timezone_id int

ID of the timezone used for the caps if it differs from the network’s default.

project_id string

ID for the advertiser campaign or an Insertion Order.

date_live_until string

Date until when the offer can be run. Events occurring past the end of the day at the timezone of the network will be rejected. Accepted format: “yyyy-MM-dd”.

html_description string

Description of the offer for the affiliates. HTML code is accepted.

is_using_explicit_terms_and_conditions boolean

Whether the offer is using specific Terms and Conditions. When false, defaults to the network’s general Terms and Conditions.

terms_and_conditions string

Text listing the specific Terms and Conditions of the offer. Required only if is_using_explicit_terms_and_conditions is true.

is_force_terms_and_conditions boolean

Whether the affiliates are required to accept the offer’s specific Terms and Conditions.

is_caps_enabled boolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_cap int

Limit to the number of unique conversions in one day.

weekly_conversion_cap int

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)

monthly_conversion_cap int

Limit to the number of unique conversions in one month.

global_conversion_cap int

Limit to the total number of unique conversion at the offer level.

daily_payout_cap int

Limit to the affiliate’s payout for one day.

weekly_payout_cap int

Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)

monthly_payout_cap int

Limit to the affiliate’s payout for one month.

global_payout_cap int

Limit to the affiliate’s total payout at the offer level.

daily_revenue_cap int

Limit to the network’s revenue for one day.

weekly_revenue_cap int

Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)

monthly_revenue_cap int

Limit to the network’s revenue for one month.

global_revenue_cap int

Limit to the network’s total revenue at the offer level.

daily_click_cap int

Limit to the number of unique clicks in one day.

weekly_click_cap int

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_cap int

Limit to the number of unique clicks in one month.

global_click_cap int

Limit to the total number of unique clicks at the offer level.

redirect_mode string

Setting used to obscure referrer URLs from advertisers. Can be one of the following values: standard, single_meta_refresh or double_meta_refresh. Not recommended, this will cause click drop-off.

is_using_suppression_list boolean

Whether a email suppression list is used for this offer.

suppression_list_id int

ID of the suppression list associated with the offer.

is_duplicate_filter_enabled boolean

Whether duplicate clicks are filtered and acted upon, according to the offer’s duplicate_filter_targeting_action.

duplicate_filter_targeting_action string

Action that should be taken when a duplicate click is encountered. Ignored if is_duplicate_filter_enabled is false. Can be either block or fail_traffic.

network_tracking_domain_id int

ID of the tracking domain hit by clicks belonging to the offer.

is_use_secure_link boolean

Whether tracking links use the more secure https:// instead of http://. Please validate with your account manager that SSL is enabled before using the offer level setting.

is_allow_deep_link boolean

Whether affiliates can send their traffic to target URLs by adding &url=[target URL] to their tracking links, instead of the offer’s destination URL.

is_session_tracking_enabled boolean

Whether affiliate’s conversions and payouts get automatically blocked based on a minimum and maximum time from the click to the associated conversion.

session_tracking_lifespan_hour int

Maximum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

session_tracking_minimum_lifespan_second int

Minimum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

is_view_through_session_tracking_enabled boolean

Whether affiliate’s conversions and payouts get automatically blocked based on a minimum and maximum time from the impression to the associated conversion. Only relevant if is_view_through_enabled is true.

view_through_session_tracking_lifespan_minute int

Maximum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

view_through_session_tracking_minimal_lifespan_second int

Minimum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

is_block_already_converted boolean

Whether clicks from users who have already converted on this offer are acted upon according to the offer’s already_converted_action.

already_converted_action string

Action that should be taken when a click from a user who has already converted on this offer is encountered. Ignored if is_block_already_converted is false. Can be either block or fail_traffic.

visibility string

Setting for the offer’s visibility for affiliates. Can be one of the following values: public, require_approval or private. [Learn More]

conversion_method string

Method used by the Advertiser to fire tracking data to Everflow. Can be one of the following values: http_image_pixel, https_image_pixel, server_postback, cookie_based, http_iframe_pixel, https_iframe_pixel or javascript.

is_whitelist_check_enabled boolean

Whether a check is made to ensure conversion postback origin from the advertiser. [Learn More]

is_use_scrub_rate boolean

Whether a predefined percentage of conversion get arbitrarily rejected. Required only if is_must_approve_conversion is true. This mechanism prevents that an excessive number of conversion gets approved.

scrub_rate_status string

Status to apply to conversions affected by throttling. Required only if is_use_scrub_rate is true. Can be either rejected or pending.

scrub_rate_percentage int

Percentage of conversions to be automatically throttled. Required only if is_use_scrub_rate is true.

session_definition string

Method used for determining whether a click is unique. Can be one of the following values: cookie, ip, ip_user_agent, google_ad_id or idfa. [Learn More]

session_duration int

Duration (in hours) of the active session used to match a click to a conversion.

app_identifier string

Bundle ID for iOS / Android Apps

is_description_plain_text boolean

Whether the description of the offer should be interpreted as plain text.

is_use_direct_linking boolean

Whether the offer is using Direct Linking.

meta object

View Object Details Hide Object Details

advertiser_campaign_name string

Optional advertiser campaign name

creatives object array

View Object Details Hide Object Details

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html or email.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file.

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

is_fail_traffic_enabled boolean

Whether the invalid clicks will be redirected to another offer.

redirect_routing_method string

Control how fail traffic is handled. For now, the only value allowed is internal. Only relevant if is_fail_traffic_enabled is true.

redirect_internal_routing_type string

Redirect mechanism that determines how the fail traffic is distributed between listed offers. Can be one of the following values: priority, weight, priority_global or weight_global. Only relevant if is_fail_traffic_enabled is true.

internal_redirects object array

Should only be included if is_fail_traffic_enabled is true.

View Object Details Hide Object Details

redirect_network_offer_id int

ID of the offer where to redirect the traffic. One and only one of redirect_network_offer_id, redirect_network_offer_group_id, redirect_network_campaign_id or is_pass_through must be provided.

redirect_network_offer_url_id int

ID of the offer URL where to redirect the traffic. Required only if redirect_network_offer_id is provided. Use value 0 for the default offer URL.

redirect_network_offer_group_id int

ID of the offer group where to redirect the traffic. One and only one of redirect_network_offer_id, redirect_network_offer_group_id, redirect_network_campaign_id or is_pass_through must be provided.

redirect_network_campaign_id int

ID of the smartlink where to redirect the traffic. One and only one of redirect_network_offer_id, redirect_network_offer_group_id, redirect_network_campaign_id or is_pass_through must be provided.

routing_value int

The value use to determine priority or weight of the redirect. If redirect_internal_routing_type is priority or priority_global, the routing value is the order in which the redirects are evaluated, starting with 1 and going up. If redirect_internal_routing_type is weight or weight_global, the routing value is the weight of the redirect proportional to the total weights of the redirects. For example, with two redirects of weight 1 and 2 respectively, the first will receive 33% of the redirected traffic, and the second 66%.

ruleset object

Additional targeting rules for determining when the fail traffic rule is used. See the ruleset object.

categories string array

Additional requirements for redirect to receive the fail traffic. It has to reach the redirect in the priority/weight queue, and the reason for the invalid traffic also needs to match one of the selected categories, in order for that redirect to receive the traffic. Can be one of the following values: traffic_filter, traffic_control, already_converted, offer_expired, geotargeting, caps or other.

is_pay_affiliate boolean

Whether the affiliate will receive the payout if traffic is sent to the redirect. Both is_pay_affiliate and is_pass_through cannot be true.

is_pass_through boolean

Whether the fail traffic should be sent to the destination URL of the offer. One and only one of redirect_network_offer_id, redirect_network_offer_group_id, redirect_network_campaign_id or is_pass_through must be provided. Both is_pay_affiliate and is_pass_through cannot be true.

is_apply_specific_affiliates boolean

Whether the redirect applies for the affiliates specified by network_affiliate_ids or for all affiliates.

network_affiliate_ids int array

IDs of the affiliates for which this redirect applies. Only required if is_apply_specific_affiliates is true.

ruleset object

List of rules for the that determine what traffic is allowed / block at the offer level. See the ruleset object.

traffic_filters object array

View Object Details Hide Object Details

parameter string

Parameter on which to filter traffic. Can be one of the following values: sub1, sub2, sub3, sub4, sub5, source_id, user_agent, referer, idfa, google_advertiser_id, http_accept_language or creative_id.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact, minimum, maximum, contains, starts_with, range, ends_with, blank, does_not_match or does_not_contain.

value string

Value of the selected parameter to evaluate.

action string

Action to be taken if the incoming parameter value matches the provided value and match_type. Can be either block of fail_traffic.

email object

View Object Details Hide Object Details

is_enabled boolean

Whether approved Subject and From lines for emails are used.

subject_lines string

Approved Subject lines for emails. Only relevant if is_enabled is true.

from_lines string

Approved From lines for emails. Only relevant if is_enabled is true.

email_optout object

View Object Details Hide Object Details

is_enabled boolean

Whether approved Subject and From lines for emails are used.

suppression_file_link string

URL of the link to the suppression files.

unsub_link string

URL of the link to unsubscribe.

labels string array

Labels are use for organizing offers by private internal keywords.

source_names string array

Names of the source.

payout_revenue object array

View Object Details Hide Object Details

entry_name string

Name for the base conversion. Defaults as Base.

payout_type string

Types of payout. Can be one of the following values: cpc, cpa, cpm, cps, cpa_cps or prv.

payout_amount double

Amount of the payout. Not required if payout_type is cps or prv.

payout_percentage int

Percentage of the payout. Only required if payout_type is cps, cpa_cps or prv.

revenue_type string

Types of revenue. Can be one of the following values: rpc, rpa, rpm, rps or rpa_rps.

revenue_amount double

Amount of the revenue. Not required if revenue_type is rps.

revenue_percentage int

Percentage of the revenue. Only required if revenue_type is rps or rpa_rps.

is_default boolean

Must be set to true for the base conversion.

is_private boolean

Must be set to false for the base conversion.

is_postback_disabled boolean

Enabling will prevent the partners postback from being fired on the successful initial conversion. Enabling this feature is useful whenever the base conversion is not tied to a payable action.

global_advertiser_event_id int

ID of the global advertiser event.

is_must_approve_conversion boolean

Enabling will hide all conversions from partners and won’t fire their postbacks. These conversions may be viewed under Reporting > Conversions and Status : ‘Pending’.

is_allow_duplicate_conversion boolean

Enabling allows partners to deliver multiple ‘Approved’ conversions from the same Transaction ID. If disabled, those conversions are rejected and not payable to partners.

thumbnail_file object

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

integrations object

View Object Details Hide Object Details

optizmo object

View Object Details Hide Object Details

optoutlist_id string

ID of the Optizmo Optout List.

twentyfour_metrics object

View Object Details Hide Object Details

network_integration_twentyfour_metrics_tracker_id int

ID of the tracker.

forensiq object

View Object Details Hide Object Details

click_threshold int

Threshold for clicks above which the action will occur. One of click_threshold or conversion_threshold must be above 0.

action string

Action to take for clicks that fail to meet the click threshold. Can be one of the following values: block or fail_traffic.

conversion_threshold int

Threshold for conversions above which the conversion_status will be applied. One of click_threshold or conversion_threshold must be above 0.

conversion_status string

Status to apply to conversions that fail to meet the conversion threshold. Can be one of the following values: pending or rejected.

ezepo object

View Object Details Hide Object Details

enabled boolean

Whether the ezepo integration is enabled for the offer.

anura object

View Object Details Hide Object Details

enabled boolean

Whether the anura integration is enabled for the offer.

invoca object

View Object Details Hide Object Details

enabled boolean

Whether the invoca integration is enabled for the offer.

channels object array

View Object Details Hide Object Details

network_channel_id int

ID of the channel.

requirement_kpis object array

View Object Details Hide Object Details

kpi string

KPI threshold required by traffic provider.

requirement_tracking_parameters object array

View Object Details Hide Object Details

tracking_parameter string

Tracking parameter required by traffic provider.

value string

Value of the tracking parameter required by traffic provider.

email_attribution_method string

Can be one of the following values: first_affiliate_attribution or first_affiliate_attribution.

attribution_method string

Can be one of the following values: first_touch or last_touch.

Response Example

 {
      "network_offer_id": 1,
      "network_id": 1,
      "network_advertiser_id": 13,
      "network_offer_group_id": 5,
      "name": "Offer Example",
      "thumbnail_url": "",
      "network_category_id": 1,
      "internal_notes": "",
      "destination_url": "http://everflowclient.io/test.php?aid={affiliate_id}&oid={offer_id}&tid={transaction_id}",
      "server_side_url": "",
      "is_view_through_enabled": false,
      "view_through_destination_url": "",
      "preview_url": "",
      "offer_status": "active",
      "currency_id": "USD",
      "caps_timezone_id": 0,
      "project_id": "",
      "date_live_until": "",
      "html_description": "",
      "is_using_explicit_terms_and_conditions": false,
      "terms_and_conditions": "",
      "is_force_terms_and_conditions": false,
      "is_caps_enabled": false,
      "daily_conversion_cap": 0,
      "weekly_conversion_cap": 0,
      "monthly_conversion_cap": 0,
      "global_conversion_cap": 0,
      "daily_payout_cap": 0,
      "weekly_payout_cap": 0,
      "monthly_payout_cap": 0,
      "global_payout_cap": 0,
      "daily_revenue_cap": 0,
      "weekly_revenue_cap": 0,
      "monthly_revenue_cap": 0,
      "global_revenue_cap": 0,
      "daily_click_cap": 0,
      "weekly_click_cap": 0,
      "monthly_click_cap": 0,
      "global_click_cap": 0,
      "redirect_mode": "standard",
      "is_using_suppression_list": false,
      "suppression_list_id": 0,
      "is_must_approve_conversion": false,
      "is_allow_duplicate_conversion": true,
      "is_duplicate_filter_enabled": false,
      "duplicate_filter_targeting_action": "unknown",
      "network_tracking_domain_id": 1,
      "is_use_secure_link": false,
      "is_seo_friendly": false,
      "is_allow_deep_link": false,
      "is_session_tracking_enabled": false,
      "session_tracking_start_on": "null_value",
      "session_tracking_lifespan_hour": 0,
      "session_tracking_minimum_lifespan_second": 0,
      "is_view_through_session_tracking_enabled": false,
      "view_through_session_tracking_lifespan_minute": 0,
      "view_through_session_tracking_minimal_lifespan_second": 0,
      "is_block_already_converted": false,
      "already_converted_action": "unknown",
      "is_fail_traffic_enabled": false,
      "redirect_routing_method": "internal",
      "redirect_internal_routing_type": "priority",
      "visibility": "public",
      "time_created": 1592409065,
      "time_saved": 1592409065,
      "conversion_method": "server_postback",
      "is_whitelist_check_enabled": false,
      "is_use_scrub_rate": false,
      "scrub_rate_status": "null_value",
      "scrub_rate_percentage": 0,
      "session_definition": "cookie",
      "session_duration": 24,
      "app_identifier": "",
      "is_description_plain_text": false,
      "is_use_direct_linking": false,
      "relationship": {
        "category": {
          "network_category_id": 1,
          "network_id": 1,
          "name": "Finance",
          "status": "active",
          "time_created": 1592409064,
          "time_saved": 1592409064
        },
        "labels": {
          "total": 0,
          "entries": []
        },
        "payout_revenue": {
          "total": 1,
          "entries": [
            {
              "network_offer_payout_revenue_id": 1,
              "network_id": 1,
              "network_offer_id": 1,
              "entry_name": "",
              "payout_type": "cpa",
              "payout_amount": 0.8,
              "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": 1592409065,
              "global_advertiser_event_id": 0,
              "is_must_approve_conversion": false,
              "is_allow_duplicate_conversion": true
            }
          ]
        },
        "encoded_value": "2CTPL",
        "is_locked_currency": false,
        "channels": {
          "total": 0,
          "entries": []
        },
        "is_locked_caps_timezone": false,
        "requirement_kpis": {
          "total": 0,
          "entries": []
        },
        "requirement_tracking_parameters": {
          "total": 0,
          "entries": []
        }
      }
    }

Copy

GET /v1/networks/offers/:offerId/copy

This endpoint allows you to make a complete copy of an offer that already exists. The different options give you control over which additional settings should be copied along with the offer.

When successful, this endpoint returns the new offer copy.

Path Parameters

Parameter	Description
offerId	The ID of the offer you want to copy

Query String Parameters

Parameter	Description
is_copy_custom_settings	Determines whether custom settings (custom payout & revenue, caps, throttle rate and landing page settings) will be copied along with the offer
is_copy_creatives	Determines whether the creatives will be copied along with the offer. Custom creatives will also be copied along when this option is set to true
is_copy_visibility	Determines whether affiliate visibility is copied along with the offer
is_copy_additional_urls	Determines whether Offer URLs are copied along with the offer
is_copy_forwarding_rules	Determines whether forwarding rules are copied along with the offer
name	Determines the name of the copied offer. Note that this must be URL encoded since it is passed in the query string (eg `Copied%20Offer%20--%20%5BCPA%5D%20Web%20Sale!` for the name `Copied Offer -- [CPA] Web Sale!`). If the `name` parameter is omitted entirely, the copied offer will be name `<Old Offer Name> (Copy)`

Request Examples

curl --request GET 'https://api.eflow.team/v1/networks/offers/<offer_id>/copy' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \

When omitted, the query string parameters will default to false. So for example, hitting the following endpoint :

https://api.eflow.team/v1/networks/offers/151/copy?is_copy_custom_settings=true&is_copy_visibility=true

is the same as hitting :

https://api.eflow.team/v1/networks/offers/151/copy?is_copy_custom_settings=true&is_copy_visibility=true&is_copy_additional_urls=false&is_copy_forwarding_rules=false&is_copy_creatives=false

In both cases, offer ID 151 will be copied, along with the following settings :

Custom Payout & Revenue Settings
Custom Cap Settings
Custom Landing Pages
Custom Throttle Rate Settings
Offer Visibility

Creatives, Forwarding rules and Offer URLs would not be copied over in this example.

Update

PUT /v1/networks/offers/:offerId

While it is possible to updates offers using this endpoint, it’s important to note that because of the nature of the offer object in Everflow, the payload that must be passed here is extremely complex. Updating an offer via this endpoint requires you to pass the entire object.

The Bulk Edit endpoint documented below allows you to update only certain fields on an offer, which is much less error prone.

Path Parameters

Parameter	Description
offerId	The ID of the offer you want to update

Body Params

network_advertiser_id int

ID of the advertiser submitting the offer.

network_offer_group_id int

ID of the offer group associated with the offer.

name string

Displayed name of the offer.

thumbnail_url string

URL of the image thumbnail associated with the offer and visible to network and affiliates.

network_category_id int

ID of the category type associated with the offer.

internal_notes string

Notes on the offer for network employees. Not displayed to affiliates and advertisers.

destination_url string

URL of the final landing page associated with the offer, including additional macros if applicable.

server_side_url string

Server-side URL that will be asynchronously fired by Everflow following a click.

is_view_through_enabled boolean

Whether conversions can be generated from impressions (as opposed to being generated from clicks only).

view_through_destination_url string

URL of the final landing page associated with the offer when redirected from an impression (including additional macros if applicable). Only relevant if is_view_through_enabled is true.

preview_url string

URL of a preview of the offer landing page.

offer_status string

Status of the offer. Can be one of the following values: active, paused, pending or deleted.

currency_id string

Currency used to compute payouts, costs and revenues of the offer.

caps_timezone_id int

ID of the timezone used for the caps if it differs from the network’s default.

project_id string

ID for the advertiser campaign or an Insertion Order.

date_live_until string

Date until when the offer can be run. Events occurring past the end of the day at the timezone of the network will be rejected. Accepted format: “yyyy-MM-dd”.

html_description string

Description of the offer for the affiliates. HTML code is accepted.

is_using_explicit_terms_and_conditions boolean

Whether the offer is using specific Terms and Conditions. When false, defaults to the network’s general Terms and Conditions.

terms_and_conditions string

Text listing the specific Terms and Conditions of the offer. Required only if is_using_explicit_terms_and_conditions is true.

is_force_terms_and_conditions boolean

Whether the affiliates are required to accept the offer’s specific Terms and Conditions.

is_caps_enabled boolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_cap int

Limit to the number of unique conversions in one day.

weekly_conversion_cap int

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)

monthly_conversion_cap int

Limit to the number of unique conversions in one month.

global_conversion_cap int

Limit to the total number of unique conversion at the offer level.

daily_payout_cap int

Limit to the affiliate’s payout for one day.

weekly_payout_cap int

Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)

monthly_payout_cap int

Limit to the affiliate’s payout for one month.

global_payout_cap int

Limit to the affiliate’s total payout at the offer level.

daily_revenue_cap int

Limit to the network’s revenue for one day.

weekly_revenue_cap int

Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)

monthly_revenue_cap int

Limit to the network’s revenue for one month.

global_revenue_cap int

Limit to the network’s total revenue at the offer level.

daily_click_cap int

Limit to the number of unique clicks in one day.

weekly_click_cap int

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_cap int

Limit to the number of unique clicks in one month.

global_click_cap int

Limit to the total number of unique clicks at the offer level.

redirect_mode string

is_using_suppression_list boolean

Whether a email suppression list is used for this offer.

suppression_list_id int

ID of the suppression list associated with the offer.

is_duplicate_filter_enabled boolean

Whether duplicate clicks are filtered and acted upon, according to the offer’s duplicate_filter_targeting_action.

duplicate_filter_targeting_action string

Action that should be taken when a duplicate click is encountered. Ignored if is_duplicate_filter_enabled is false. Can be either block or fail_traffic.

network_tracking_domain_id int

ID of the tracking domain hit by clicks belonging to the offer.

is_use_secure_link boolean

Whether tracking links use the more secure https:// instead of http://. Please validate with your account manager that SSL is enabled before using the offer level setting.

is_allow_deep_link boolean

Whether affiliates can send their traffic to target URLs by adding &url=[target URL] to their tracking links, instead of the offer’s destination URL.

is_session_tracking_enabled boolean

Whether affiliate’s conversions and payouts get automatically blocked based on a minimum and maximum time from the click to the associated conversion.

session_tracking_lifespan_hour int

Maximum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

session_tracking_minimum_lifespan_second int

Minimum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

is_view_through_session_tracking_enabled boolean

view_through_session_tracking_lifespan_minute int

Maximum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

view_through_session_tracking_minimal_lifespan_second int

Minimum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

is_block_already_converted boolean

Whether clicks from users who have already converted on this offer are acted upon according to the offer’s already_converted_action.

already_converted_action string

visibility string

Setting for the offer’s visibility for affiliates. Can be one of the following values: public, require_approval or private. [Learn More]

conversion_method string

is_whitelist_check_enabled boolean

Whether a check is made to ensure conversion postback origin from the advertiser. [Learn More]

is_use_scrub_rate boolean

NOT SURE Whether a predefined percentage of conversion get arbitrarily rejected. Required only if is_must_approve_conversion is true. This mechanism prevents that an excessive number of conversion gets approved.

scrub_rate_status string

Status to apply to conversions affected by throttling. Required only if is_use_scrub_rate is true. Can be either rejected or pending.

scrub_rate_percentage int

Percentage of conversions to be automatically throttled. Required only if is_use_scrub_rate is true.

session_definition string

Method used for determining whether a click is unique. Can be one of the following values: cookie, ip, ip_user_agent, google_ad_id or idfa. [Learn More]

session_duration int

Duration (in hours) of the active session used to match a click to a conversion.

app_identifier string

Bundle ID for iOS / Android Apps

is_description_plain_text boolean

Whether the description of the offer should be interpreted as plain text.

is_use_direct_linking boolean

Whether the offer is using Direct Linking.

meta object

View Object Details Hide Object Details

advertiser_campaign_name string

Optional advertiser campaign name

creatives object array

View Object Details Hide Object Details

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html or email.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file.

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

is_fail_traffic_enabled boolean

Whether the invalid clicks will be redirected to another offer.

redirect_routing_method string

Control how fail traffic is handled. For now, the only value allowed is internal. Only relevant if is_fail_traffic_enabled is true.

redirect_internal_routing_type string

internal_redirects object array

Should only be included if is_fail_traffic_enabled is true.

View Object Details Hide Object Details

redirect_network_offer_id int

redirect_network_offer_url_id int

ID of the offer URL where to redirect the traffic. Required only if redirect_network_offer_id is provided. Use value 0 for the default offer URL.

redirect_network_offer_group_id int

redirect_network_campaign_id int

routing_value int

ruleset object

Additional targeting rules for determining when the fail traffic rule is used. See the ruleset object.

categories string array

is_pay_affiliate boolean

Whether the affiliate will receive the payout if traffic is sent to the redirect. Both is_pay_affiliate and is_pass_through cannot be true.

is_pass_through boolean

is_apply_specific_affiliates boolean

Whether the redirect applies for the affiliates specified by network_affiliate_ids or for all affiliates.

network_affiliate_ids int array

IDs of the affiliates for which this redirect applies. Only required if is_apply_specific_affiliates is true.

ruleset object

List of rules for the that determine what traffic is allowed / block at the offer level. See the ruleset object.

traffic_filters object array

View Object Details Hide Object Details

parameter string

match_type string

value string

Value of the selected parameter to evaluate.

action string

Action to be taken if the incoming parameter value matches the provided value and match_type. Can be either block of fail_traffic.

email object

View Object Details Hide Object Details

is_enabled boolean

Whether approved Subject and From lines for emails are used.

subject_lines string

Approved Subject lines for emails. Only relevant if is_enabled is true.

from_lines string

Approved From lines for emails. Only relevant if is_enabled is true.

email_optout object

View Object Details Hide Object Details

is_enabled boolean

Whether approved Subject and From lines for emails are used.

suppression_file_link string

URL of the link to the suppression files.

unsub_link string

URL of the link to unsubscribe.

labels string array

Labels are use for organizing offers by private internal keywords.

source_names string array

Names of the source.

payout_revenue object array

View Object Details Hide Object Details

entry_name string

Name for the base conversion. Defaults as Base.

payout_type string

Types of payout. Can be one of the following values: cpc, cpa, cpm, cps, cpa_cps or prv.

payout_amount double

Amount of the payout. Not required if payout_type is cps or prv.

payout_percentage int

Percentage of the payout. Only required if payout_type is cps, cpa_cps or prv.

revenue_type string

Types of revenue. Can be one of the following values: rpc, rpa, rpm, rps or rpa_rps.

revenue_amount double

Amount of the revenue. Not required if revenue_type is rps.

revenue_percentage int

Percentage of the revenue. Only required if revenue_type is rps or rpa_rps.

is_default boolean

Must be set to true for the base conversion.

is_private boolean

Must be set to false for the base conversion.

is_postback_disabled boolean

Enabling will prevent the partners postback from being fired on the successful initial conversion. Enabling this feature is useful whenever the base conversion is not tied to a payable action.

global_advertiser_event_id int

ID of the global advertiser event.

is_must_approve_conversion boolean

Enabling will hide all conversions from partners and won’t fire their postbacks. These conversions may be viewed under Reporting > Conversions and Status : ‘Pending’.

is_allow_duplicate_conversion boolean

Enabling allows partners to deliver multiple ‘Approved’ conversions from the same Transaction ID. If disabled, those conversions are rejected and not payable to partners.

thumbnail_file object

View Object Details Hide Object Details

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

integrations object

View Object Details Hide Object Details

optizmo object

View Object Details Hide Object Details

optoutlist_id string

ID of the Optizmo Optout List.

twentyfour_metrics object

View Object Details Hide Object Details

network_integration_twentyfour_metrics_tracker_id int

ID of the tracker.

forensiq object

View Object Details Hide Object Details

click_threshold int

Threshold for clicks above which the action will occur. One of click_threshold or conversion_threshold must be above 0.

action string

Action to take for clicks that fail to meet the click threshold. Can be one of the following values: block or fail_traffic.

conversion_threshold int

Threshold for conversions above which the conversion_status will be applied. One of click_threshold or conversion_threshold must be above 0.

conversion_status string

Status to apply to conversions that fail to meet the conversion threshold. Can be one of the following values: pending or rejected.

ezepo object

View Object Details Hide Object Details

enabled boolean

Whether the ezepo integration is enabled for the offer.

anura object

View Object Details Hide Object Details

enabled boolean

Whether the anura integration is enabled for the offer.

invoca object

View Object Details Hide Object Details

enabled boolean

Whether the invoca integration is enabled for the offer.

channels object array

View Object Details Hide Object Details

network_channel_id int

ID of the channel.

requirement_kpis object array

View Object Details Hide Object Details

kpi string

KPI threshold required by traffic provider.

requirement_tracking_parameters object array

View Object Details Hide Object Details

tracking_parameter string

Tracking parameter required by traffic provider.

value string

Value of the tracking parameter required by traffic provider.

email_attribution_method string

Can be one of the following values: first_affiliate_attribution or first_affiliate_attribution.

attribution_method string

Can be one of the following values: first_touch or last_touch.

Response Example

{
  "network_offer_id": 1,
  "network_id": 1,
  "network_advertiser_id": 13,
  "network_offer_group_id": 3,
  "name": "Offer Example",
  "thumbnail_url": "",
  "network_category_id": 1,
  "internal_notes": "",
  "destination_url": "http://everflowclient.io/test.php?aid={affiliate_id}&oid={offer_id}&tid={transaction_id}",
  "server_side_url": "",
  "is_view_through_enabled": false,
  "view_through_destination_url": "",
  "preview_url": "",
  "offer_status": "active",
  "currency_id": "USD",
  "caps_timezone_id": 0,
  "project_id": "",
  "date_live_until": "",
  "html_description": "",
  "is_using_explicit_terms_and_conditions": false,
  "terms_and_conditions": "",
  "is_force_terms_and_conditions": false,
  "is_caps_enabled": false,
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 0,
  "daily_payout_cap": 0,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 0,
  "global_click_cap": 0,
  "redirect_mode": "standard",
  "is_using_suppression_list": false,
  "suppression_list_id": 0,
  "is_must_approve_conversion": false,
  "is_allow_duplicate_conversion": true,
  "is_duplicate_filter_enabled": false,
  "duplicate_filter_targeting_action": "unknown",
  "network_tracking_domain_id": 1,
  "is_use_secure_link": false,
  "is_seo_friendly": false,
  "is_allow_deep_link": false,
  "is_session_tracking_enabled": false,
  "session_tracking_start_on": "null_value",
  "session_tracking_lifespan_hour": 0,
  "session_tracking_minimum_lifespan_second": 0,
  "is_view_through_session_tracking_enabled": false,
  "view_through_session_tracking_lifespan_minute": 0,
  "view_through_session_tracking_minimal_lifespan_second": 0,
  "is_block_already_converted": false,
  "already_converted_action": "unknown",
  "is_fail_traffic_enabled": false,
  "redirect_routing_method": "internal",
  "redirect_internal_routing_type": "priority",
  "visibility": "public",
  "time_created": 1594391076,
  "time_saved": 1594391076,
  "conversion_method": "server_postback",
  "is_whitelist_check_enabled": false,
  "is_use_scrub_rate": false,
  "scrub_rate_status": "null_value",
  "scrub_rate_percentage": 0,
  "session_definition": "cookie",
  "session_duration": 24,
  "app_identifier": "",
  "is_description_plain_text": false,
  "is_use_direct_linking": false,
  "is_email_attribution_enabled": false,
  "is_email_attribution_window_enabled": true,
  "email_attribution_window_minute": 1440,
  "email_attribution_window_type": "dynamic",
  "relationship": {
    "category": {
      "network_category_id": 1,
      "network_id": 1,
      "name": "Finance",
      "status": "active",
      "time_created": 1592409064,
      "time_saved": 1592409064
    },
    "labels": {
      "total": 0,
      "entries": []
    },
    "payout_revenue": {
      "total": 1,
      "entries": [
        {
          "network_offer_payout_revenue_id": 1,
          "network_id": 1,
          "network_offer_id": 1,
          "entry_name": "",
          "payout_type": "cpa",
          "payout_amount": 0.8,
          "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": 1594391076,
          "global_advertiser_event_id": 0,
          "is_must_approve_conversion": false,
          "is_allow_duplicate_conversion": true,
          "is_email_attribution_default_event": false
        }
      ]
    },
    "encoded_value": "2CTPL",
    "is_locked_currency": false,
    "channels": {
      "total": 0,
      "entries": []
    },
    "is_locked_caps_timezone": false,
    "requirement_kpis": {
      "total": 0,
      "entries": []
    },
    "requirement_tracking_parameters": {
      "total": 0,
      "entries": []
    }
  }

Bulk Edit

PATCH /v1/networks/patch/offers/apply

This endpoint allows you to update selected fields of one or multiple offers at the same time. It does not require the entire offer object to be passed in the payload. Only the properties that need to be changed must be supplied.

Note that certain properties must be updated together. For example updating offers to set the is_caps_enabled to true without specifiying cap values would result in an invalid request.

This endpoint cannot be used to manage the partner visibility over offers. See here to the visibility documentation.

Request Body

Body Param

network_offer_ids int array

IDs of the offers to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the offers. Can be one of the following values: overwrite, append, delete, or clear. Not all options are possible for every field. append, delete and clear only apply for fields that contain multiple values.

Body Example

{
    "network_offer_ids": [
        7,
        23
    ],
    "fields": [
        {
            "field_type": "offer_status",
            "field_value": "paused",
            "operator": "overwrite"
        }
    ]
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/patch/offers/apply' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Pause multiple offers at the same time :

{
    "network_offer_ids": [
        7,
        23
    ],
    "fields": [
        {
            "field_type": "offer_status",
            "field_value": "paused",
            "operator": "overwrite"
        }
    ]
}

Example 2 : Update the base payout / revenue settings of a single offer

{
    "network_offer_ids": [
        18
    ],
    "fields": [
        {
            "field_type": "payout_revenue_name",
            "field_value": "Updated Base Event Name",
            "operator": "overwrite"
        },
        {
            "field_type": "payout",
            "field_value": {
                "payout_type": "cpa",
                "payout_amount": 2.5,
                "payout_percentage": null
            },
            "operator": "overwrite"
        },
        {
            "field_type": "revenue",
            "field_value": {
                "revenue_type": "rps",
                "revenue_amount": null,
                "revenue_percentage": 25
            },
            "operator": "overwrite"
        }
    ]
}

Example 3 : Add 2 new events to an existing offer, one of which is a private event :

{
    "network_offer_ids": [
        3
    ],
    "fields": [
        {
            "field_type": "additional_events",
            "field_value": [
                {
                    "entry_name": "Additional Event",
                    "revenue_type": "rpa",
                    "revenue_amount": 3,
                    "revenue_percentage": null,
                    "payout_type": "cpa",
                    "payout_amount": 2,
                    "payout_percentage": null,
                    "is_allow_duplicate_conversion": true,
                    "is_must_approve_conversion": false,
                    "is_private": false,
                    "is_enforce_caps": false,
                    "is_postback_disabled": false
                },
                {
                     "entry_name": "Manually Approved Private Event",
                     "revenue_type": "rps",
                     "revenue_amount": null,
                     "revenue_percentage": 50,
                     "is_allow_duplicate_conversion": true,
                     "is_must_approve_conversion": true,
                     "is_private": true,
                     "is_enforce_caps": false,
                     "is_postback_disabled": true
                }
            ],
            "operator": "append"
        }
    ]
}

Example 4 : Enable Caps and set a daily click cap and a global payout cap on multiple offers at once :

{
    "network_offer_ids": [
        100,
        103
    ],
    "fields": [
        {
            "field_type": "is_caps_enabled",
            "field_value": true,
            "operator": "overwrite"
        },
        {
            "field_type": "daily_conversion_cap",
            "field_value": 5000,
            "operator": "overwrite"
        },
        {
            "field_type": "global_payout_cap",
            "field_value": 2000,
            "operator": "overwrite"
        }
    ]
}

Example 5 : Add new targeting rules that only allows iOS traffic from the US on multiple offers :

{
    "network_offer_ids": [
        21,
        30
    ],
    "fields": [
        {
            "field_type": "ruleset_countries",
            "field_value": [
                {
                    "country_id": 227,
                    "match_type": "exact",
                    "targeting_type": "include",
                    "label": "United States"
                }
            ],
            "operator": "overwrite"
        },
        {
            "field_type": "ruleset_platforms",
            "field_value": [
                {
                    "platform_id": 2,
                    "match_type": "exact",
                    "targeting_type": "include",
                    "label": "iOS"
                }
            ],
            "operator": "overwrite"
        }
    ]
}

Example 6 : Special case where we allow string / replace on the offer destination URLs. Even though these are not patchable fields per se, they are defined specifically to allow for string replace operations on multiple operations. If you have a group of offers for which the destination URL is https://www.domain-1.com/... and you would like to change domain-1 to something different, the following call will work :

{
    "network_offer_ids": [
        1,
        2,
        3,
        4,
        5
    ],
    "fields": [
      {
        "field_type": "destination_url_replace",
         "field_value": {
            "find": "domain-1",
            "replace": "domain-2"
         }
      }
   ]
}

The fields on which the string replace operation is supported are : destination_url_replace, server_side_url_replace and view_through_destination_url_replace.

Response

{
  "result": true
}

Patch Preview

POST /v1/networks/patch/offers/submit

Body Params

network_offer_ids int array

IDs of the offers to be patched.

fields object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_type string

Type of the field to patch. See here for the list of types.

field_value

Value of the field to patch. See here for the list of values.

operator string

Operator determining how the field will be used to modify the offers. Can be one of the following values: overwrite, append, delete, or clear.

Response

changes object array

View Object Details Hide Object Details

network_offer object

An offer part of the patch submission.

View Object Details Hide Object Details

network_offer_id int

ID of the offer.

name string

Name of the offer.

offer_status string

Status of the offer. Can be one of the following values: active, paused, pending or deleted.

change_status string

Status of the change. Can be one of the following values: ok, no_change or error.

current_field object

View Object Details Hide Object Details

field_type string

Type of the field before the patch. See here for the list of types.

field_value

Value of the field before the patch. See here for the list of values.

changed_field object

View Object Details Hide Object Details

field_type string

Type of the field after the patch. See here for the list of types.

field_value

Value of the field after the patch. See here for the list of values.

error_message string

Error message for that particular field. Only filled when change_status is error.

related_changes string

Message detailing other changes that will happen as a consequence of the particular change.

resource_errors object array

If some of the offers that are part of the patch are not in a valid state prior to the patch, the patch will not be attempted and instead a list of the offer errors will be returned here.

View Object Details Hide Object Details

id int

ID of the invalid offer.

label string

Name of the invalid offer.

message string

Message indicating in which way the offer is invalid.

Patchable Fields

The fields below are to be used in the Bulk Edit and Patch Preview endpoints documented above.

Fields

offer_status string

Status of the offer. Can be one of the following values: active, paused, pending or deleted.

network_advertiser_id int

ID of the advertiser

network_offer_group_id int

ID of the offer group associated with the offer

network_category_id int

ID of the category associated with the offer

currency_id string

Currency used to compute payouts costs and revenues of the offer.

offer_name string

Displayed name of the offer.

labels string array

Labels are used for organizing offers by private internal keywords.

app_identifier string

Bundle ID for iOS / Android Apps

internal_notes string

Notes on the offer for network employees. Not displayed to affiliates and advertisers.

project_id string

ID for the advertiser campaign or an Insertion Order.

channels object array

View Object Details Hide Object Details

network_channel_id int

ID of the channel

status string

Status of the channel. Can be one of the following values: active or inactive.

date_live_until string

Date until when the offer can be run. Events occurring past the end of the day at the timezone of the network will be rejected.

html_description string

Description of the offer for the affiliates. HTML code is accepted.

is_offer_description_plaintext boolean

Whether the description of the offer should be interpreted as plain text.

destination_url string

URL of the final landing page associated with the offer, including additional macros if applicable. Referred to as the offer’s default landing page URL in the UI.

preview_url string

Preview URL associated with the offer

server_side_url string

URL of the page that will be called from the server side of Everflow, including additional macros if applicable.

view_through_destination_url string

URL of the final landing page associated with the offer when redirected from an impression (including additional macros if applicable). Only relevant if is_view_through_enabled is true.

invoca_enabled boolean

Whether the Invoca integration is enabled for the offer

payout_revenue_name string

Name for the initial conversion action.

revenue object

View Object Details Hide Object Details

revenue_type string

Type of revenue. Can be rpc, rpa, rpm, rps or rpa_rps.

revenue_amount double

Amount of revenue. Not required or relevant for revenue type rps.

revenue_percentage int

Percentage of revenue. Only relevant and required with revenue type rps or rpa_rps

payout object

View Object Details Hide Object Details

payout_type string

Type of payout. Can be cpc, cpa, cpm, cps, cpa_cps or prv.

payout_amount double

Amount of payout. Not required or relevant for payout type cps or prv.

payout_percentage int

Percentage of payout. Only relevant and required with payout type cps, cpa_cps or prv.

is_must_approve_conversion boolean

Enabling will hide all conversions from partners and won’t fire their postbacks. These conversions may be viewed under Reporting > Conversions and Status : ‘Pending’.

is_allow_duplicate_conversion boolean

Enabling allows partners to deliver multiple ‘Approved’ conversions from the same Transaction ID. If disabled, those conversions are rejected and not payable to partners.

is_postback_disabled boolean

Enabling will prevent the partners postback from being fired on the successful initial conversion. Enabling this feature is useful whenever the base conversion is not tied to a payable action.

network_tracking_domain_id int

ID of the tracking domain hit by clicks belonging to the offer.

conversion_method string

is_use_secure_link boolean

Whether tracking links use the more secure https:// instead of http://. Please validate with your account manager that SSL is enabled before using the offer level setting.

is_allow_deep_link boolean

Whether affiliates can send their traffic to target URLs by adding &url=[target URL] to their tracking links, instead of the offer’s destination URL.

is_use_direct_linking boolean

Whether the offer is using Direct Linking.

is_caps_enabled boolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_cap int

Limit to the number of unique conversions in one day.

weekly_conversion_cap int

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)

monthly_conversion_cap int

Limit to the number of unique conversions in one month.

global_conversion_cap int

Limit to the total number of unique conversion at the offer level.

daily_payout_cap int

Limit to the affiliate’s payout for one day.

weekly_payout_cap int

Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)

monthly_payout_cap int

Limit to the affiliate’s payout for one month.

global_payout_cap int

Limit to the affiliate’s total payout at the offer level.

daily_revenue_cap int

Limit to the network’s revenue for one day.

weekly_revenue_cap int

Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)

monthly_revenue_cap int

Limit to the network’s revenue for one month.

global_revenue_cap int

Limit to the network’s total revenue at the offer level.

daily_click_cap int

Limit to the number of unique clicks in one day.

weekly_click_cap int

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_cap int

Limit to the number of unique clicks in one month.

global_click_cap int

Limit to the total number of unique clicks at the offer level.

visibility string

Setting for the offer’s visibility for affiliates. Can be one of the following values: public, require_approval or private. [Learn More]

is_using_explicit_terms_and_conditions boolean

Whether the offer is using specific Terms and Conditions. When false, defaults to the network’s general Terms and Conditions.

is_force_terms_and_conditions boolean

Whether the affiliates are required to accept the offer’s specific Terms and Conditions.

terms_and_conditions string

Text listing the specific Terms and Conditions of the offer. Required only if is_using_explicit_terms_and_conditions is true.

is_whitelist_check_enabled boolean

Whether a check is made to ensure conversion postback origin from the advertiser. [Learn More]

session_definition string

Method used for determining whether a click is unique. Can be one of the following values: cookie, ip, ip_user_agent, google_ad_id or idfa. [Learn More]

session_duration string

Duration (in hours) of the active session used to match a click to a conversion.

is_duplicate_filter_enabled boolean

Whether duplicate clicks are filtered and acted upon, according to the offer’s duplicate_filter_targeting_action.

duplicate_filter_targeting_action string

Action that should be taken when a duplicate click is encountered. Ignored if is_duplicate_filter_enabled is false. Can be either block or fail_traffic.

redirect_mode string

requirement_kpis object array

View Object Details Hide Object Details

kpi string

KPI threshold required by traffic provider.

requirement_tracking_parameters object array

View Object Details Hide Object Details

tracking_parameter string

Tracking parameter required by traffic provider.

value string

Value of the tracking parameter required by traffic provider.

is_block_already_converted boolean

Whether clicks from users who have already converted on this offer are acted upon according to the offer’s already_converted_action.

already_converted_action string

is_use_scrub_rate boolean

scrub_rate_status string

Status to apply to conversions affected by throttling. Required only if is_use_scrub_rate is true. Can be either rejected or pending.

scrub_rate_percentage int

Percentage of conversions to be automatically throttled. Required only if is_use_scrub_rate is true.

is_session_tracking_enabled boolean

Whether affiliate’s conversions and payouts get automatically blocked based on a minimum and maximum time from the click to the associated conversion.

session_tracking_lifespan_hour int

Maximum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

session_tracking_minimum_lifespan_second int

Minimum interval of time between the click event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

is_view_through_enabled boolean

Whether conversions can be generated from impressions (as opposed to being generated from clicks only).

is_view_through_session_tracking_enabled boolean

view_through_session_tracking_lifespan_minute int

Maximum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

view_through_session_tracking_minimal_lifespan_second int

Minimum interval of time between the impression event and a valid conversion or event. Required only if is_session_tracking_enabled is true.

twentyfour_metrics_network_integration_twentyfour_metrics_tracker_id int

ID of the tracker.

forensiq_is_forensiq_click_threshold_enabled boolean

Whether the threshold for clicks is enabled.

forensiq_click_threshold int

Threshold for clicks above which the action will occur. One of click_threshold or conversion_threshold must be above 0.

forensiq_action string

Action to take for clicks that fail to meet the click threshold. Can be one of the following values: block or fail_traffic.

forensiq_is_forensiq_conversion_threshold_enabled boolean

Whether the threshold for conversions is enabled.

forensiq_conversion_threshold int

Threshold for conversions above which the conversion_status will be applied. One of click_threshold or conversion_threshold must be above 0.

forensiq_conversion_status string

Status to apply to conversions that fail to meet the conversion threshold. Can be one of the following values: pending or rejected.

anura_enabled boolean

Whether the anura integration is enabled for the offer.

ip_quality_score_enabled boolean

Whether the scrubkit integration is enabled for the offer.

ip_quality_score_min_fraud_score string

Threshold for traffic above which the ip_quality_score_action will be applied.

ip_quality_score_min_fraud_score_mobile string

Threshold for mobile traffic above which the ip_quality_score_action will be applied.

ip_quality_score_action string

Action to take for traffic that fail to meet the threshold. Can be one of the following values: block or fail_traffic.

scrubkit_enabled boolean

Whether the scrubkit integration is enabled for the offer.

ruleset_platforms object array

Platforms are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

platform_id int

ID of the platform

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_device_types object array

Device types are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

device_type_id int

ID of the device type.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

brands object array

Brands are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

brand_id int

ID of the brand.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_browsers object array

Browsers are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

browser_id int

ID of the browser.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_os_versions object array

OS versions are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

platform_id int

ID of the platform.

os_version_id int

ID of the OS version.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact, minimum, maximum.

ruleset_languages object array

Browser languages are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

browser_language_id int

ID of the browser language.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_countries object array

Countries are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

country_id int

ID of the country.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_postal_codes object array

ZIP / Postal Codes are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

postal_code string

Identifier of the ZIP / Postal Code. Spaces and case are ignored.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_regions object array

Regions are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

region_id int

ID of the region.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_cities object array

Cities are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

city_id int

ID of the city.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_dmas object array

DMAs are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

dma_code int

DMA code.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_mobile_carriers object array

Mobile Carriers are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

mobile_carrier_id int

ID of the mobile carrier.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_isps object array

ISPs are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

isp_id int

ID of the ISP.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_connection_types object array

Connection types are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

connection_type_id int

ID of the connection type.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_ips object array

IPs are used to narrow down the targeting of your offers, campaigns, custom settings, etc.

View Object Details Hide Object Details

ip_from string

Lower bound of the IP address range.

ip_to string

Upper bound of the IP address range.

targeting_type string

The targeting type. Can either be include or exclude.

match_type string

Setting determining how the values are matched. Can be one of the following values: exact.

ruleset_is_block_proxy boolean

Whether or not traffic from well known proxy will be blocked.

traffic_filters string

ruleset_is_use_day_parting boolean

Whether day parting is enabled.

ruleset_day_parting_apply_to string

Setting determining the timezone the day parting is applied to. Can be one of the following values: user_timezone or selected_timezone. Only required if is_use_day_parting is true.

ruleset_day_parting_timezone_id int

ID of the day parting timezone. Only required if is_use_day_parting is true and if day_parting_apply_to has the value selected_timezone.

ruleset_days_parting object array

The day parting objects. Only required if is_use_day_parting is true.

View Object Details Hide Object Details

day_of_week int

The day of the week the day parting applies to. Sunday corresponds to 0.

start_hour int

The hour of the beginning of the day parting range.

start_minute int

The minute of the beginning of the day parting range.

end_hour int

The hour of the end of the day parting range.

end_minute int

The minute of the end of the day parting range.

is_fail_traffic_enabled boolean

Whether the invalid clicks will be redirected to another offer.

redirect_internal_routing_type string

email_is_enabled boolean

Whether approved Subject and From lines for emails are used.

email_subject_lines string

Approved Subject lines for emails. Only relevant if is_enabled is true.

email_from_lines string

Approved From lines for emails. Only relevant if is_enabled is true.

email_optout_is_enabled boolean

Whether the suppression file url and unsubscribe link for emails are used.

email_optout_suppression_file_link string

URL of the link to the suppression files.

email_optout_unsub_link string

URL of the link to unsubscribe.

ezepo_enabled boolean

Whether the ezepo integration is enabled for the offer.

optizmo_optoutlist_id string

ID of the Optizmo Optout List.

Export

POST /v1/networks/export/offers

Body Params

format string

Format of the export. Can be one of the following values: csv or json.

fields string array

Offer fields to be included in the file, from the following values:

network_offer_id, name, category, network_advertiser_id, network_offer_group_id, internal_notes, destination_url, server_side_url, is_view_through_enabled, view_through_destination_url, preview_url, offer_status, currency_id, project_id, date_live_until, is_using_explicit_terms_and_conditions, terms_and_conditions, is_caps_enabled, daily_conversion_cap, weekly_conversion_cap, monthly_conversion_cap, global_conversion_cap, daily_payout_cap, weekly_payout_cap, monthly_payout_cap, global_payout_cap, daily_revenue_cap, weekly_revenue_cap, monthly_revenue_cap, global_revenue_cap, daily_click_cap, weekly_click_cap, monthly_click_cap, global_click_cap, redirect_mode, is_must_approve_conversion, is_allow_duplicate_conversion, is_duplicate_filter_enabled, duplicate_filter_targeting_action, network_tracking_domain_id, is_use_secure_link, is_allow_deep_link, is_session_tracking_enabled, session_tracking_lifespan_hour, is_view_through_session_tracking_enabled, view_through_session_tracking_lifespan_minute, is_fail_traffic_enabled, redirect_routing_method, redirect_internal_routing_type, visibility, time_created, time_saved, conversion_method, is_whitelist_check_enabled, is_use_scrub_rate, scrub_rate_status, scrub_rate_percentage, session_definition, session_duration, app_identifier, entry_name, payout_type, payout_amount, payout_percentage, revenue_type, revenue_amount, revenue_percentage, network_advertiser_name, network_advertiser_account_manager, network_advertiser_sales_manager, suppression_file_url, unsubscribe_url, countries, network_tracking_domain_url, category_name, channels.

If omitted, will return all fields.

query object

The query containing the information to filter the data.

View Object Details Hide Object Details

search_terms object array

Terms used to filter the data.

View Object Details Hide Object Details

search_type string

Type of the terms of the search. Can be one of the following values: name or advertiser_name.

value string

Value of the term to filter by.

filters object

Filters to apply to the data.

View Object Details Hide Object Details

network_category_ids int array

IDs of the categories to be included.

labels string array

Labels of the categories to be included.

network_affiliate_id int

affiliate_runnable_status string

Can be one of the following values: runnable, blocked or all.

network_advertiser_id int

ID of the offers’ advertiser.

network_offer_group_id int

ID of the offer group of the offers.

visibilities string array

Visibilities of the offers to be included in the file, from the following values: public, require_approval, private.

demand_partner_ids int array

IDs of the EverXchange partners of the offers.

account_manager_ids int array

IDs of the account managers of the advertisers of the offers.

revenue_types string array

Types of the revenue of the offers to be included in the file, from the following values: RPC, RPA, RPM, RPS, RPA_RPS.

payout_types string array

Types of the payout of the offers to be included in the file, from the following values: CPC, CPA, CPM, CPS, CPA_CPS, PRV.

platform_ids int array

IDs of the platforms targeted by the offers to be included in the file.

country_ids int array

IDs of the countries targeted by the offers to be included in the file.

business_unit_ids int array

IDs of the business units of the account managers of the advertisers of the offers.

offer_status string

Status of the offer to be included in the file. Can be one of the following values: active, paused, pending or deleted.

sales_manager_ids int array

IDs of the sale managers of the advertisers of the offers.

network_tracking_domain_ids int array

IDs of the tracking domains of the offers.

network_channel_ids int array

IDs of the channels of the offers.

is_24metrics_enabled string

Status of the 24Metrics integration for the offers. Can be either enabled or disabled.

is_forensiq_enabled string

Status of the Forensiq integration for the offers. Can be either enabled or disabled.

is_anura_enabled string

Status of the Anura integration for the offers. Can be either enabled or disabled.

is_ip_quality_score_enabled string

Status of the IPQualityScore integration for the offers. Can be either enabled or disabled.

is_ezepo_enabled string

Status of the Ezepo integration for the offers. Can be either enabled or disabled.

is_optizmo_enabled string

Status of the Optizmo integration for the offers. Can be either enabled or disabled.

is_scrubkit_enabled string

Status of the Scrubkit integration for the offers. Can be either enabled or disabled.

device_type_ids int array

IDs of the device types targeted by the offers to be included in the file.

network_affiliate_tier_ids int array

IDs of the affiliate tiers of the offers to be included in the file.

included_network_offer_ids int array

Specific IDs of offers to be included in the file.

excluded_network_offer_ids int array

Specific IDs of offers to be excluded from the file.

included_offer_ids_overrides_other_filters boolean

Whether the offers specified in included_network_offer_ids should be included regardless of the other filters.

Docs: Offer Applications

Mon, 01 Jan 0001 00:00:00 +0000

Find All Applications

GET /v1/networks/applicationstable

This endpoint allows to fetch offer applications. Different filters can be used to narrow down the set of applications that will be returned by the endpoint. You can, for example, use the filters to only return the applications made on a specific offer ID.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

Search terms are optional but can be used to look for specific words.

View Object Details Hide Object Details

search_type string

The name of the field used for search. On this endpoint, it can only ever be name. Searching by name will actually search the the offer ID as well as the offer name.

value string

The value to search.

filters object

Filters are also completely optional but are usually used to narrow down the set of applications returned. They can be used individually or combined in a single request.

View Object Details Hide Object Details

network_affiliate_ids int array

One or multiple partner IDs for which the applications will be returned.

network_advertiser_ids int array

Only the applications made on offers from the specified advertiser IDs will be returned.

network_offer_group_ids int array

Only the applications made on offers that belong to the specified offer group IDs will be returned.

network_offer_ids int array

Only the applications made on offers from the specified IDs will be returned.

account_manager_ids int array

Only the applications from partners managed by the specified account manager ids will be returned.

application_status string

Only return applications with the specified status. Values can be : approved, pending or rejected

Request Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/applicationstable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Find all applications from partner IDs 1 and 2

{
    "filters":
    {
        "network_affiliate_ids": [1, 2]
    }
}

Example 2 : Find all pending applications on offers that have the work “Game” in their name

{
    "search_terms":
    [
        {
            "search_type": "name",
            "value": "Game"
        }
    ],
    "filters":
    {
        "application_status": "pending"
    }
}

Response

{
  "applications": [
    {
      "network_application_id": 3,
      "network_id": 1,
      "network_affiliate_id": 7,
      "network_employee_id": 1,
      "network_offer_id": 117,
      "network_affiliate_user_id": 11,
      "application_status": "pending",
      "time_created": 1686330773,
      "time_saved": 1686330773,
      "relationship": {
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "Example Affiliate Inc.",
          "account_status": "active"
        },
        "offer": {
          "network_offer_id": 117,
          "network_id": 1,
          "name": "Game Offer Example",
          "offer_status": "active"
        },
        "advertiser": {
          "network_advertiser_id": 52,
          "network_id": 1,
          "name": "Example Advertiser Inc.",
          "account_status": "active"
        },
        "employee": {
          "network_employee_id": 1,
          "network_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "account_status": "active"
        }
      }
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 50,
    "total_count": 1
  }
}

Find All

GET /v1/networks/applications

Filters

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

Value	Description
network_affiliate_id	Filter based on the affiliate id
network_offer_id	Filter based on the offer id
network_affiliate_user_id	Filter based on the user id
application_status	Filter based on the application status
time_created	Filter based on the creation time
time_saved	Filter based on the last update time

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/applications' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "applications": [ { "application_status": "approved", "network_affiliate_id": 1, "network_affiliate_user_id": 7, "network_application_id": 22, "network_id": 5, "network_offer_id": 38, "relationship": { "advertiser": { "account_status": "active", "name": "Test Adv 12-19", "network_advertiser_id": 9, "network_id": 5 }, "affiliate": { "account_executive_id": 39, "account_status": "active", "adress_id": 0, "default_currency_id": "USD", "enable_media_cost_tracking_links": true, "has_notifications": true, "internal_notes": "Fraud fraud fraud", "is_contact_address_enabled": false, "name": "Test Aff", "network_affiliate_id": 1, "network_employee_id": 101, "network_id": 5, "network_traffic_source_id": 39, "referrer_id": 90, "time_created": 1483607342, "time_saved": 1594850506 }, "offer": { "currency_id": "USD", "name": "Offer 38", "network_advertiser_id": 9, "network_id": 5, "network_offer_group_id": 0, "network_offer_id": 38, "network_tracking_domain_id": 8, "offer_status": "paused", "visibility": "require_approval" } }, "time_created": 1496178429, "time_saved": 1496182703 } ] }

Patch

PATCH /v1/networks/networks/applications

Body Params

patches object array

List of fields to patch. See here for the list of types and their corresponding values.

View Object Details Hide Object Details

field_name string

Name of the field to patch. Use application_status to modify the status of the application and the offer visibility.

field_value string

Target value of the field to be patched. application_status target values are approved and rejected.

network_application_ids int array

List of the application ids you want to patch.

Request Example

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/applications' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Request

{
  "network_application_ids": [
    148,
    170
  ],
  "patches": [
    {
      "field_name": "application_status",
      "field_value": "approved"
    }
  ],
  "send_email": false
}

Docs: Offer Groups

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/offergroups

Relationships

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

Value	Description
audits	Includes the offer group’s audits information
reporting	Includes the offer group’s reporting for today

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/offergroups' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "offer_groups": [
        {
            "network_offer_group_id": 1,
            "network_id": 1,
            "network_advertiser_id": 13,
            "name": "Expedia Travel",
            "internal_notes": "",
            "offer_group_status": "deleted",
            "is_caps_enabled": true,
            "daily_conversion_cap": 0,
            "weekly_conversion_cap": 100,
            "monthly_conversion_cap": 0,
            "global_conversion_cap": 1000,
            "daily_payout_cap": 0,
            "weekly_payout_cap": 0,
            "monthly_payout_cap": 0,
            "global_payout_cap": 0,
            "daily_revenue_cap": 0,
            "weekly_revenue_cap": 0,
            "monthly_revenue_cap": 0,
            "global_revenue_cap": 0,
            "daily_click_cap": 0,
            "weekly_click_cap": 0,
            "monthly_click_cap": 0,
            "global_click_cap": 0,
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "relationship": {
                "advertiser": {
                    "network_advertiser_id": 13,
                    "network_id": 1,
                    "name": "Michael Good Inc.",
                    "account_status": "active",
                    "network_employee_id": 2,
                    "internal_notes": "",
                    "address_id": 0,
                    "is_contact_address_enabled": false,
                    "sales_manager_id": 0,
                    "is_expose_publisher_reporting_data": null,
                    "default_currency_id": "USD",
                    "platform_name": "",
                    "platform_url": "",
                    "platform_username": "",
                    "reporting_timezone_id": 67,
                    "accounting_contact_email": "",
                    "verification_token": "",
                    "offer_id_macro": "oid",
                    "affiliate_id_macro": "affid",
                    "time_created": 1602783082,
                    "time_saved": 1602783082,
                    "attribution_method": "last_touch",
                    "email_attribution_method": "last_affiliate_attribution"
                },
                "labels": {
                    "total": 0,
                    "entries": []
                },
                "network_offer_ids": [
                    5,
                    6,
                    22
                ],
                "remaining_caps": {
                    "remaining_daily_payout_cap": -1000,
                    "remaining_daily_revenue_cap": -1000,
                    "remaining_daily_conversion_cap": -1000,
                    "remaining_daily_click_cap": -1000,
                    "remaining_weekly_payout_cap": -1000,
                    "remaining_weekly_revenue_cap": -1000,
                    "remaining_weekly_conversion_cap": 100,
                    "remaining_weekly_click_cap": -1000,
                    "remaining_monthly_payout_cap": -1000,
                    "remaining_monthly_revenue_cap": -1000,
                    "remaining_monthly_conversion_cap": -1000,
                    "remaining_monthly_click_cap": -1000,
                    "remaining_global_payout_cap": -1000,
                    "remaining_global_revenue_cap": -1000,
                    "remaining_global_conversion_cap": 1000,
                    "remaining_global_click_cap": -1000
                }
            }
        }
    ]
}

Find By ID

GET /v1/networks/offergroups/:offerGroupId

Relationships

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

Value	Description
audits	Includes the offer group’s audits information
reporting	Includes the offer group’s reporting for today

Path Parameters

Parameter	Description
offerId	The ID of the offer group you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/offergroups/<INSERT OFFER GROUP ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "network_offer_group_id": 1,
    "network_id": 1,
    "network_advertiser_id": 13,
    "name": "Expedia Travel",
    "internal_notes": "",
    "offer_group_status": "deleted",
    "is_caps_enabled": true,
    "daily_conversion_cap": 0,
    "weekly_conversion_cap": 100,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 1000,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 0,
    "time_created": 1602783082,
    "time_saved": 1602783082,
    "relationship": {
        "advertiser": {
            "network_advertiser_id": 13,
            "network_id": 1,
            "name": "Michael Good Inc.",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "address_id": 0,
            "is_contact_address_enabled": false,
            "sales_manager_id": 0,
            "is_expose_publisher_reporting_data": null,
            "default_currency_id": "USD",
            "platform_name": "",
            "platform_url": "",
            "platform_username": "",
            "reporting_timezone_id": 67,
            "accounting_contact_email": "",
            "verification_token": "",
            "offer_id_macro": "oid",
            "affiliate_id_macro": "affid",
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "attribution_method": "last_touch",
            "email_attribution_method": "last_affiliate_attribution"
        },
        "labels": {
            "total": 0,
            "entries": []
        },
        "network_offer_ids": [
            5,
            6,
            22
        ],
        "remaining_caps": {
            "remaining_daily_payout_cap": -1000,
            "remaining_daily_revenue_cap": -1000,
            "remaining_daily_conversion_cap": -1000,
            "remaining_daily_click_cap": -1000,
            "remaining_weekly_payout_cap": -1000,
            "remaining_weekly_revenue_cap": -1000,
            "remaining_weekly_conversion_cap": 100,
            "remaining_weekly_click_cap": -1000,
            "remaining_monthly_payout_cap": -1000,
            "remaining_monthly_revenue_cap": -1000,
            "remaining_monthly_conversion_cap": -1000,
            "remaining_monthly_click_cap": -1000,
            "remaining_global_payout_cap": -1000,
            "remaining_global_revenue_cap": -1000,
            "remaining_global_conversion_cap": 1000,
            "remaining_global_click_cap": -1000
        }
    }
}

Create

POST /v1/networks/offergroups

Body Params

network_advertiser_id int

ID of the advertiser for the offer group.

name string

internal_notes string

offer_group_status string

Status of the offer group. Can be one of the following values: active, paused or deleted.

is_caps_enabled boolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_cap int

Limit to the number of unique conversions in one day.

weekly_conversion_cap int

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)

monthly_conversion_cap int

Limit to the number of unique conversions in one month.

global_conversion_cap int

Limit to the total number of unique conversion at the offer level.

daily_payout_cap int

Limit to the affiliate’s payout for one day.

weekly_payout_cap int

Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)

monthly_payout_cap int

Limit to the affiliate’s payout for one month.

global_payout_cap int

Limit to the affiliate’s total payout at the offer level.

daily_revenue_cap int

Limit to the network’s revenue for one day.

weekly_revenue_cap int

Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)

monthly_revenue_cap int

Limit to the network’s revenue for one month.

global_revenue_cap int

Limit to the network’s total revenue at the offer level.

daily_click_cap int

Limit to the number of unique clicks in one day.

weekly_click_cap int

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_cap int

Limit to the number of unique clicks in one month.

global_click_cap int

Limit to the total number of unique clicks at the offer level.

network_offer_ids int array

Ids of the offers included in the offer group.

labels string array

Payload Example

{
    "network_advertiser_id": 13,
    "name": "",
    "internal_notes": "",
    "offer_group_status": "active",
    "is_caps_enabled": false,
    "internal_notes": "",
    "daily_conversion_cap": 0,
    "weekly_conversion_cap": 100,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 1000,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 0,
    "network_offer_ids": [
        7,
        10
    ],
    "labels": [
        "Sport",
        "School"
    ]
}

Request Example

cURL

curl --request POST \
  --url 'https://api.eflow.team/v1/networks/offergroups' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
    "network_offer_group_id": 6,
    "network_id": 1,
    "network_advertiser_id": 13,
    "name": "",
    "internal_notes": "",
    "offer_group_status": "active",
    "is_caps_enabled": false,
    "daily_conversion_cap": 0,
    "weekly_conversion_cap": 100,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 1000,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 0,
    "time_created": 1603822910,
    "time_saved": 1603822910,
    "relationship": {
        "advertiser": {
            "network_advertiser_id": 13,
            "network_id": 1,
            "name": "Michael Good Inc.",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "address_id": 0,
            "is_contact_address_enabled": false,
            "sales_manager_id": 0,
            "is_expose_publisher_reporting_data": null,
            "default_currency_id": "USD",
            "platform_name": "",
            "platform_url": "",
            "platform_username": "",
            "reporting_timezone_id": 67,
            "accounting_contact_email": "",
            "verification_token": "",
            "offer_id_macro": "oid",
            "affiliate_id_macro": "affid",
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "attribution_method": "last_touch",
            "email_attribution_method": "last_affiliate_attribution"
        },
        "labels": {
            "total": 2,
            "entries": [
                "School",
                "Sport"
            ]
        },
        "network_offer_ids": [
            7,
            10
        ],
        "remaining_caps": {
            "remaining_daily_payout_cap": -1000,
            "remaining_daily_revenue_cap": -1000,
            "remaining_daily_conversion_cap": -1000,
            "remaining_daily_click_cap": -1000,
            "remaining_weekly_payout_cap": -1000,
            "remaining_weekly_revenue_cap": -1000,
            "remaining_weekly_conversion_cap": 100,
            "remaining_weekly_click_cap": -1000,
            "remaining_monthly_payout_cap": -1000,
            "remaining_monthly_revenue_cap": -1000,
            "remaining_monthly_conversion_cap": -1000,
            "remaining_monthly_click_cap": -1000,
            "remaining_global_payout_cap": -1000,
            "remaining_global_revenue_cap": -1000,
            "remaining_global_conversion_cap": 1000,
            "remaining_global_click_cap": -1000
        }
    }
}

Update

PUT /v1/networks/offergroups

Body Params

network_advertiser_id int

ID of the advertiser for the offer group.

name string

internal_notes string

offer_group_status string

Status of the offer group. Can be one of the following values: active, paused or deleted.

is_caps_enabled boolean

Whether caps are enabled. When false, voids all types of caps and custom caps.

daily_conversion_cap int

Limit to the number of unique conversions in one day.

weekly_conversion_cap int

Limit to the number of unique conversions in one week (Monday midnight to Sunday 23h59:59)

monthly_conversion_cap int

Limit to the number of unique conversions in one month.

global_conversion_cap int

Limit to the total number of unique conversion at the offer level.

daily_payout_cap int

Limit to the affiliate’s payout for one day.

weekly_payout_cap int

Limit to the affiliate’s payout for a week (Monday midnight to Sunday 23h59:59)

monthly_payout_cap int

Limit to the affiliate’s payout for one month.

global_payout_cap int

Limit to the affiliate’s total payout at the offer level.

daily_revenue_cap int

Limit to the network’s revenue for one day.

weekly_revenue_cap int

Limit to the network’s revenue for a week (Monday midnight to Sunday 23h59:59)

monthly_revenue_cap int

Limit to the network’s revenue for one month.

global_revenue_cap int

Limit to the network’s total revenue at the offer level.

daily_click_cap int

Limit to the number of unique clicks in one day.

weekly_click_cap int

Limit to the number of unique clicks in a week (Monday midnight to Sunday 23h59:59).

monthly_click_cap int

Limit to the number of unique clicks in one month.

global_click_cap int

Limit to the total number of unique clicks at the offer level.

network_offer_ids int array

Ids of the offers included in the offer group.

labels string array

Payload Example

{
    "network_advertiser_id": 13,
    "name": "",
    "internal_notes": "",
    "offer_group_status": "active",
    "is_caps_enabled": false,
    "internal_notes": "",
    "daily_conversion_cap": 0,
    "weekly_conversion_cap": 100,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 1000,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 0,
    "network_offer_ids": [
        7,
        10
    ],
    "labels": [
        "Sport",
        "School"
    ]
}

Request Example

cURL

curl --request PUT \
  --url 'https://api.eflow.team/v1/networks/offergroups/<INSERT OFFER GROUP ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'

Response

{
    "network_offer_group_id": 6,
    "network_id": 1,
    "network_advertiser_id": 13,
    "name": "",
    "internal_notes": "",
    "offer_group_status": "active",
    "is_caps_enabled": false,
    "daily_conversion_cap": 0,
    "weekly_conversion_cap": 100,
    "monthly_conversion_cap": 0,
    "global_conversion_cap": 1000,
    "daily_payout_cap": 0,
    "weekly_payout_cap": 0,
    "monthly_payout_cap": 0,
    "global_payout_cap": 0,
    "daily_revenue_cap": 0,
    "weekly_revenue_cap": 0,
    "monthly_revenue_cap": 0,
    "global_revenue_cap": 0,
    "daily_click_cap": 0,
    "weekly_click_cap": 0,
    "monthly_click_cap": 0,
    "global_click_cap": 0,
    "time_created": 1603822910,
    "time_saved": 1603822910,
    "relationship": {
        "advertiser": {
            "network_advertiser_id": 13,
            "network_id": 1,
            "name": "Michael Good Inc.",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "address_id": 0,
            "is_contact_address_enabled": false,
            "sales_manager_id": 0,
            "is_expose_publisher_reporting_data": null,
            "default_currency_id": "USD",
            "platform_name": "",
            "platform_url": "",
            "platform_username": "",
            "reporting_timezone_id": 67,
            "accounting_contact_email": "",
            "verification_token": "",
            "offer_id_macro": "oid",
            "affiliate_id_macro": "affid",
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "attribution_method": "last_touch",
            "email_attribution_method": "last_affiliate_attribution"
        },
        "labels": {
            "total": 2,
            "entries": [
                "School",
                "Sport"
            ]
        },
        "network_offer_ids": [
            7,
            10
        ],
        "remaining_caps": {
            "remaining_daily_payout_cap": -1000,
            "remaining_daily_revenue_cap": -1000,
            "remaining_daily_conversion_cap": -1000,
            "remaining_daily_click_cap": -1000,
            "remaining_weekly_payout_cap": -1000,
            "remaining_weekly_revenue_cap": -1000,
            "remaining_weekly_conversion_cap": 100,
            "remaining_weekly_click_cap": -1000,
            "remaining_monthly_payout_cap": -1000,
            "remaining_monthly_revenue_cap": -1000,
            "remaining_monthly_conversion_cap": -1000,
            "remaining_monthly_click_cap": -1000,
            "remaining_global_payout_cap": -1000,
            "remaining_global_revenue_cap": -1000,
            "remaining_global_conversion_cap": 1000,
            "remaining_global_click_cap": -1000
        }
    }
}

Docs: Offer URLs

Mon, 01 Jan 0001 00:00:00 +0000

Offer URLs allow you to add additional destinations on an existing offer. They are documented in detail on the Everflow Helpdesk.

Find All

GET /v1/networks/offerurls

This endpoint can be used to fetch all offer URLs. This endpoint is typically used with a filter on the network_offer_id field.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

The maximum page size for this endpoint is set to 2000. Omitting to specify the page / page size will result in the first 2000 offer URLs being returned.

Filters

This endpoint supports the following API filters. Refer to our User Guide for usage.

Value	Description
network_offer_id	only fetch the offer URLs associated with the offer ID specified
url_status	`active`, `paused` or `deleted`
time_created	The time at which the offer url was created
time_saved	The time at which the offer url was last modified

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/offerurls?filter=network_offer_id%3D6' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "urls": [
    {
      "network_offer_url_id": 1,
      "network_id": 1,
      "network_offer_id": 6,
      "name": "Offer Url Name A",
      "destination_url": "http://destination-url-a.com/?tid={transaction_id}",
      "preview_url": "http://preview-url-a.com",
      "url_status": "active",
      "network_affiliate_ids": [
        7,
        14
      ],
      "is_apply_specific_affiliates": true,
      "is_hidden_affiliate": true,
      "time_created": 1614284258,
      "time_saved": 1614285020
    },
    {
      "network_offer_url_id": 2,
      "network_id": 1,
      "network_offer_id": 6,
      "name": "Offer Url Name B",
      "destination_url": "http://destination-url-b.com/?tid={transaction_id}",
      "preview_url": "http://preview-url-b.com",
      "url_status": "paused",
      "network_affiliate_ids": [
        7,
        14
      ],
      "is_apply_specific_affiliates": true,
      "is_hidden_affiliate": true,
      "time_created": 1614285172,
      "time_saved": 1614286134
    }
  ]
}

Find By ID

GET /v1/networks/offerurls/:offerUrlId

Find an offer URL by its unique ID

Path Parameters

Parameter	Description
offerUrlId	The ID of the offer URL you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/offerurls/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_offer_url_id": 1,
  "network_id": 1,
  "network_offer_id": 6,
  "name": "Offer Url Name",
  "destination_url": "http://destination-url.com/?tid={transaction_id}",
  "preview_url": "http://preview-url.com",
  "url_status": "active",
  "network_affiliate_ids": [
    14,
    7
  ],
  "is_apply_specific_affiliates": true,
  "is_hidden_affiliate": true,
  "time_created": 1614284258,
  "time_saved": 1614285020
}

Create

POST /v1/networks/offerurls

Create a new Offer URL setting. All offer URL settings must be associated to one (and only one) offer.

If you have a large number of offer URLs to add, you can consider using the Create (Bulk) endpoint documented below.

Request Body

Body Params

network_offer_id int

The ID of the offer to which this offer URL is associated.

name string

The name of the offer URL.

destination_url string

The URL the offer URL will redirect to.

preview_url string

A preview URL, if it exists

url_status string

Status of the offer URL setting. Can be one of : active, paused, deleted.

is_apply_specific_affiliates boolean

Determines whether this offer URL applies to all affiliates or only to a select few. When true, the network_affiliate_ids array must be filled

network_affiliate_ids int array

The IDs of the affiliates that are to be affected by the offer URL. Only relevant when is_apply_specific_affiliates is true.

is_hidden_affiliate boolean

Determines whether affiliates will see this offer URL or not in the affiliate UI / API.

Body Example

{
    "network_offer_id": 6,
    "name": "Offer Url Name",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "preview_url": "http://preview-url.com",
    "url_status": "active",
    "network_affiliate_ids": [
        7,
        14
    ],
    "is_apply_specific_affiliates": true,
    "is_hidden_affiliate": true
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/offerurls' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Response

{
  "network_id": 1,
  "network_offer_id": 6,
  "name": "Offer Url Name",
  "destination_url": "http://destination-url.com/?tid={transaction_id}",
  "preview_url": "http://preview-url.com",
  "url_status": "active",
  "network_affiliate_ids": [
    7,
    14
  ],
  "is_apply_specific_affiliates": true,
  "is_hidden_affiliate": true,
  "time_created": 1614285172,
  "time_saved": 1614285172
}

Create (Bulk)

POST /v1/networks/offerurls/bulk

Create multiple offer URL settings at the same time.

Request Body

The endpoint takes an array of objects where each object is defined as :

network_offer_id int

The ID of the offer to which this offer URL is associated.

name string

The name of the offer URL.

destination_url string

The URL the offer URL will redirect to.

preview_url string

A preview URL, if it exists

url_status string

Status of the offer URL setting. Can be one of : active, paused, deleted.

is_apply_specific_affiliates boolean

Determines whether this offer URL applies to all affiliates or only to a select few. When true, the network_affiliate_ids array must be filled

network_affiliate_ids int array

The IDs of the affiliates that are to be affected by the offer URL. Only relevant when is_apply_specific_affiliates is true.

is_hidden_affiliate boolean

Determines whether affiliates will see this offer URL or not in the affiliate UI / API.

Body Example

[
  {
    "network_offer_id": 15,
    "name": "Offer Url A",
    "destination_url": "http://destination-url-a.com?tid={transaction_id}",
    "preview_url": "http://preview-url-a.com",
    "url_status": "active",
    "is_apply_specific_affiliates": false,
    "is_hidden_affiliate": false
  },
  {
    "network_offer_id": 15,
    "name": "Offer Url B",
    "destination_url": "http://destination-url-b.com?tid={transaction_id}",
    "preview_url": "http://preview-url-b.com",
    "url_status": "active",
    "is_apply_specific_affiliates": true,
    "network_affiliate_ids": [
	    7,
	    14
    ],
    "is_hidden_affiliate": false
  },
  {
    "network_offer_id": 16,
    "name": "Offer Url C",
    "destination_url": "http://destination-url-c.com?tid={transaction_id}",
    "preview_url": "http://preview-url-c.com",
    "url_status": "active",
    "is_apply_specific_affiliates": true,
    "network_affiliate_ids": [
    	14
    ],
    "is_hidden_affiliate": true
  }
]

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/offerurls/bulk' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Response

{
  "urls": [
    {
      "network_offer_url_id": 6,
      "network_id": 1,
      "network_offer_id": 15,
      "name": "Offer Url A",
      "destination_url": "http://destination-url-a.com?tid={transaction_id}",
      "preview_url": "http://preview-url-a.com",
      "url_status": "active",
      "network_affiliate_ids": null,
      "is_apply_specific_affiliates": false,
      "is_hidden_affiliate": false,
      "time_created": 1614285696,
      "time_saved": 1614285696
    },
    {
      "network_offer_url_id": 7,
      "network_id": 1,
      "network_offer_id": 15,
      "name": "Offer Url B",
      "destination_url": "http://destination-url-b.com?tid={transaction_id}",
      "preview_url": "http://preview-url-b.com",
      "url_status": "active",
      "network_affiliate_ids": [
        7,
        14
      ],
      "is_apply_specific_affiliates": true,
      "is_hidden_affiliate": false,
      "time_created": 1614285696,
      "time_saved": 1614285696
    },
    {
      "network_offer_url_id": 8,
      "network_id": 1,
      "network_offer_id": 16,
      "name": "Offer Url C",
      "destination_url": "http://destination-url-c.com?tid={transaction_id}",
      "preview_url": "http://preview-url-c.com",
      "url_status": "active",
      "network_affiliate_ids": [
        14
      ],
      "is_apply_specific_affiliates": true,
      "is_hidden_affiliate": true,
      "time_created": 1614285696,
      "time_saved": 1614285696
    }
  ]
}

Update

PUT /v1/networks/offerurls/:offerUrlId

Update an existing offer URL.

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Note: if you’re looking to update multiple offer URLs at the same time, consider using the Bulk Update endpoint documented below.

Path Parameters

Parameter	Description
offerUrlId	The ID of the offer URL you want to update

Request Body

Body Params

network_offer_url_id int

The unique ID of the offer URL.

network_offer_id int

The ID of the offer to which this offer URL is associated.

name string

The name of the offer URL.

destination_url string

The URL the offer URL will redirect to.

preview_url string

A preview URL, if it exists

url_status string

Status of the offer URL setting. Can be one of : active, paused, deleted.

is_apply_specific_affiliates boolean

Determines whether this offer URL applies to all affiliates or only to a select few. When true, the network_affiliate_ids array must be filled

network_affiliate_ids int array

The IDs of the affiliates that are to be affected by the offer URL. Only relevant when is_apply_specific_affiliates is true.

is_hidden_affiliate boolean

Determines whether affiliates will see this offer URL or not in the affiliate UI / API.

Body Example

{
    "network_offer_url_id": 1,
    "network_offer_id": 6,
    "name": "Offer Url Name",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "preview_url": "http://preview-url.com",
    "url_status": "active",
    "network_affiliate_ids": [
        7,
        14
    ],
    "is_apply_specific_affiliates": true,
    "is_hidden_affiliate": true
}

Request Example

cURL

curl --request PUT 'https://api.eflow.team/v1/networks/offerurls/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Response

{
  "network_offer_url_id": 1,
  "network_id": 1,
  "network_offer_id": 6,
  "name": "Offer Url Name",
  "destination_url": "http://destination-url.com/?tid={transaction_id}",
  "preview_url": "http://preview-url.com",
  "url_status": "active",
  "network_affiliate_ids": [
    7,
    14
  ],
  "is_apply_specific_affiliates": true,
  "is_hidden_affiliate": true,
  "time_created": 1614284258,
  "time_saved": 1614285020
}

Bulk Update

PATCH /v1/networks/patch/offerurls/apply

This endpoint allows you to update multiple offer URLs (from a single offer) in a single call.

Unlike the regular update endpoint, where every field must be supplied, you only need to provide the data you are willing to change.

This endpoint is typically best understood by looking at the examples below.

Request Body

Body Params

network_offer_id int

The ID of the offer to which the offer URLs are associated.

network_offer_url_ids int array

The unique IDs of the offer URLs that will be modified.

fields array

A list of the fields that will be modified. Each field is built from 3 required properties :

field_type string

The name of the field that will be modified. Refer to the list

field_value string

The new value of the field

operator string

How the field will be modified. Possible values are overwrite, append, delete and clear, although not all options are possible for every field. append, delete and clear only apply for fields that contain multiple values like network_affiliate_ids.

Body Example

{
    "network_offer_id": 2,
    "network_offer_url_ids": [
        1,
        8,
        6
    ],
    "fields": [
        {
            "field_type": "url_status",
            "field_value": "paused",
            "operator": "overwrite"
        }
    ]
}

Request Examples

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/patch/offerurls/apply' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT BODY HERE>'

Example 1 : Update the status of multiple offer URLs :

{
    "network_offer_id": 2,
    "network_offer_url_ids": [
        1,
        8,
        6
    ],
    "fields": [
        {
            "field_type": "url_status",
            "field_value": "paused",
            "operator": "overwrite"
        }
    ]
}

Example 2 : Update offer URLs that previously applied to all partners but now should only apply to 2 of them :

{
    "network_offer_id": 2,
    "network_offer_url_ids": [
        25,
        26,
        27
    ],
    "fields": [
        {
            "field_type": "is_apply_specific_affiliates",
            "field_value": true,
            "operator": "overwrite"
        },
        {
            "field_type": "network_affiliate_ids",
            "field_value": [
                14,
                21
            ],
            "operator": "overwrite"
        }
    ]
}

Example 3 : Add a new partner to the list of partners to which offer URLs apply :

{
    "network_offer_id": 2,
    "network_offer_url_ids": [
        26,
        27,
        25
    ],
    "fields": [
        {
            "field_type": "network_affiliate_ids",
            "field_value": [
                35
            ],
            "operator": "append"
        }
    ]
}

Example 4 : Special case where you would want to update the destination of multiple offer URLs that were previously pointing to https://obsolete-domain.com?tid={transaction_id}&... to a new domain (only replacing the obsolete-domain.com part). This is the only scenario where the field_value contains find/replace.

{
    "network_offer_id": 2,
    "network_offer_url_ids": [
        14,
        15,
        16
    ],
    "fields": [
        {
            "field_type": "destination_url_replace",
            "field_value": {
                "find": "obsolete-domain.com",
                "replace": "new-domain.com"
            },
            "operator": "overwrite"
        }
    ]
}

Response

{
  "result": true
}

Docs: Offer Visibility

Mon, 01 Jan 0001 00:00:00 +0000

Offer visibility is what determines whether an affiliate can run a given offer or not. There are 3 possible values for affiliate visibility :

visible
hidden
rejected

Both hidden and rejected result in the same behavior : the affiliate cannot see or run the offer. While hidden and rejected are interchangeable, we recommend you use hidden over rejected when working with the Everflow API.

The configuration at the offer level is what determines the default affiliate visibility :

public offer : the default affiliate visibility is visible
require_approval offer : the default affiliate visibility is hidden
private_approval offer : the default affiliate visibility is hidden

In other words, when no visibility settings are specified for an affiliate on a public offer, the affiliate has visible visibility over that offer.

Note : modifying the visibility settings on an offer can result in notifications (email / in-app) the same way they would when performed in the Everflow UI.

Find By Offer ID

GET /v1/networks/offers/:offerId/visibility

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/:offerId/visibility' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_id": 1,
  "network_offer_id": 67,
  "network_affiliate_visible_ids": [],
  "network_affiliate_rejected_ids": [],
  "network_affiliate_hidden_ids": [
    8,
    29
  ]
}

Update

PUT /v1/networks/offers/:offerId/visibility

Please note that, when using this endpoint, the visibility passed in the payload of this endpoint will completely overwrite the existing offer visibility.

In other words, when using this endpoint, you must always pass the entire visibility for the offer.

Take the following scenario :

A) Offer ID 5 is a private offer on which affiliate IDs 3, 6 and 9 have visibility

B) A call is made to PUT /v1/networks/offers/5/visibility with the following payload :

{
  "network_affiliate_ids": [3, 10],
  "set_type": "visible"
}

The result of this call is that only affiliate IDs 3 and 10 now have visibility on offer ID 5. Because affiliate IDs 6 and 9 were omitted from the call, their visibility was removed and they were assigned the default visibility for a private offer (which is hidden).

A similar behavior will be observed on public offers : affiliates that were previously hidden but that are missing from a call to this endpoint will become visible again as a result of the operation.

Consequently, this endpoint must be used carefully to avoid unintended visibility changes.

Path Parameters

Parameter	Description
offerId	The ID of the offer for which you want to update visibility

Body Params

set_type string

The type of visibility you want to attribute to the set. Values are visible and hidden.

network_affiliate_ids int array

List of the affiliate ids you want to set to the target set_type.

Request Example

cURL

curl --request PUT 'https://api.eflow.team/v1/networks/networks/67/visibility' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Request

{
  "network_affiliate_ids": [
    16,
    19,
    22,
    23
  ],
  "set_type": "visible"
}

Patch

This endpoint allows you to update the visibility for a given affiliate on multiple offers at the same time. Unlike the Update endpoint documented above where the whole visibility must be included in the payload, you only need to include the offers on which you wish make changes.

PATCH /v1/networks/affiliates/:affiliateId/offers/visibility

Path Parameters

Parameter	Description
affiliateId	The ID of the affiliate for which you want to update visibility

Body Params

visibility_type string

The type of visibility you want to attribute to the set of offers specified. Values are visible and hidden.

network_offer_ids int array

List of the offer ids on which you want to set to the target visibility_type for the affiliate.

Request Example

cURL

curl --request PATCH 'https://api.eflow.team/v1/networks/affiliates/23/offers/visibility' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Request

{
  "network_offer_ids": [
    67
  ],
  "visibility_type": "visible"
}

Docs: Partner Postbacks

Mon, 01 Jan 0001 00:00:00 +0000

Fetch Postbacks

POST /v1/networks/pixelstable

This is the main endpoint to extract a list of partner postbacks from the API. It’s possible to filter the postbacks returned by this endpoint using 2 different methods (which can be combined) :

Search Terms : equivalent to a text search (e.g. find postbacks with a description that contains the word “media buyer”)
Query Filters : structured filters on predefined fields (e.g. find partner postbacks for partner ID 10)

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

search_terms object array

This is a text search on the name or advertiser of the offer

View Object Details Hide Object Details

search_type string

The name of the field used for search. Can be one of the following values: pixel_id, description or payload. The payload option will search in the HTML code or the postback URL, depending on the nature of the partner postback

value string

The value to search.

filters object

Structured filters

View Object Details Hide Object Details

offer_status string

Status of the partner postback. Can be one of the following values: active, inactive.

pixel_type string

Type / target of the partner postback. Can be one of the following values: conversion, post_conversion or cpc.

network_offer_ids int array

Only include postbacks that target the offers specified in the list. Note that global postbacks (that target all offers) will be returned when this filter is used.

network_affiliate_ids int array

Only include postbacks that belong to the partners specified in the list. Note that global offer postbacks (that fire regardless of the partner) will be returned when this filter is used.

delivery_methods string array

Only include partner postbacks that use one of the delivery methods specified. The array can contain multiple delivery methods, but the possibilities are : facebook, tiktok, postback, html

Examples

cURL

curl --request POST 'https://api.eflow.team/v1/networks/pixelstable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch all active conversion postbacks

{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "conversion"
    }
  }
}

To fetch, for example, the second page of 50 active conversion postbacks you would run the following call :

curl --request POST 'https://api.eflow.team/v1/networks/pixelstable?page=2&page_size=50' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "conversion",
    }
  }
}'

Example 2 : Fetch all event postbacks with delivery method postback that contain the work some-site in the URL

{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "post_conversion",
      "delivery_methods": [ "postback" ]
    },
    "search_terms": [
      {
        "search_type": "payload",
        "value": "some-site"
      }
    ]
  }
}

Response

{ "pixels": [ { "network_pixel_id": 20, "network_id": 1, "network_offer_payout_revenue_id": 0, "delivery_method": "html", "pixel_level": "specific", "pixel_status": "active", "pixel_type": "post_conversion", "postback_url": "", "html_code": "<div>pixel content</div>", "delay_ms": 0, "network_affiliate_id": 22, "network_affiliate_name": "Affiliate Name", "network_offer_id": 40, "network_offer_name": "Offer Name", "description": "", "time_created": 1496184631, "time_saved": 1498173406, "relationship": {} }, { "network_pixel_id": 112, "network_id": 1, "network_offer_payout_revenue_id": 0, "delivery_method": "postback", "pixel_level": "global_offer", "pixel_status": "active", "pixel_type": "conversion", "postback_url": "https://postbackdomain.com/?offer_id={offer_id}&transaction_id={transaction_id}&google_aid={google_aid}&idfa={idfa}", "html_code": "", "delay_ms": 0, "network_affiliate_id": 0, "network_affiliate_name": "", "network_offer_id": 81, "network_offer_name": "Other Offer Name", "description": "", "time_created": 1506462264, "time_saved": 1506462264, "relationship": {} } ], "paging": { "page": 1, "page_size": 50, "total_count": 2 } }

Find By ID

GET /v1/networks/pixels/:pixelId

Path Parameters

Parameter	Description
pixelId	The ID of the postback you want to fetch

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/pixels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "network_pixel_id": 1,
  "network_id": 1,
  "network_affiliate_id": 14,
  "network_offer_id": 0,
  "network_offer_payout_revenue_id": 0,
  "delivery_method": "postback",
  "pixel_level": "global",
  "pixel_status": "active",
  "pixel_type": "conversion",
  "postback_url": "https://postbacktest.com",
  "html_code": "",
  "delay_ms": 0,
  "description": "your postback",
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 14,
      "network_id": 1,
      "name": "Affiliate Example",
      "account_status": "active",
      "network_employee_id": 2,
      "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": 1594391076,
      "time_saved": 1594391076,
      "referrer_id": 0
    }
  },
  "facebook_pixel": null
}

Create

POST /v1/networks/pixels

Body Params

network_affiliate_id int

ID of the affiliate related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global, specific or global_offer.

network_offer_id int

ID of the offer related to the postback. Relevant only if pixel_level is specific or global_offer

pixel_status string

Status of the postback. Can either be active or inactive.

pixel_type string

Determines type of postback. Conversion is fired for the based CV action and Event is for any post-conversion events. CPC is used specifically for individual offers that have CPC payouts, and fires on every unique payable click action. It can be a conversion, post_conversion or cpc.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback aka. event_id. This is only relevant if pixel_type is post_conversion and if pixel_level is specifc or global_offer with a value of 0 selecting all payout and revenue/event id’s on the offer.

postback_url string

Url of the postback. Note that the URL requires http(s)://

html_code string

HTML code of the postback.

delay_ms int

An optional delay (expressed in milliseconds) that the system will wait before firing the postback. Only relevant when postback delivery method is used. The maximum delay allowd is 5 minutes, or 300000 milliseconds.

description string

Optional description.

facebook_pixel object

View Object Details Hide Object Details

network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

pixel_id string

ID of the postback

event_name string

Name of the event.

user_data object array

View Object Details Hide Object Details

field string

Date type of the facebook user. Can be email, phone, gender, date_of_birth, last_name, first_name, city, state, zipcode, country_code, external_id, fbc, fbp, subscription_id, or fb_login_id.

value string

Value associated with a type of data.

custom_data object array

View Object Details Hide Object Details

field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

Payload Example

{
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global_offer",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "http://test2.com?s2={sub2}&s1={sub1}",
    "html_code": "",
    "description": "Your postback"
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/pixels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Response

{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 0,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global_offer",
    "pixel_status": "inactive",
    "pixel_type": "post_conversion",
    "postback_url": "http://test2.com{sub2}{sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603484530,
    "relationship": {
        "offer": {
            "network_offer_id": 1,
            "network_id": 1,
            "network_advertiser_id": 13,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        }
    },
    "facebook_pixel": null
}

Update

PUT /v1/networks/pixels/:pixelId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
pixelId	The ID of the postback you want to update

Body Params

network_affiliate_id int

ID of the affiliate related to the postback.

network_offer_id int

ID of the offer related to the postback.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global, specific or global_offer.

pixel_status string

Status of the postback. Can either be active or inactive.

pixel_type string

postback_url string

Url of the postback. Note that the URL requires http(s)://

html_code string

HTML code of the postback.

delay_ms int

description string

Optional description.

facebook_pixel object

View Object Details Hide Object Details

network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

pixel_id string

ID of the postback

event_name string

Name of the event.

user_data object array

View Object Details Hide Object Details

field string

value string

Value associated with a type of data.

custom_data object array

View Object Details Hide Object Details

field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

Payload Example

{
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "http://test3.com?s2={sub2}&s1={sub1}",
    "html_code": "",
    "description": "Your postback"
}

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/pixels/<INSERT PIXEL ID' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Response

{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 0,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "post_conversion",
    "postback_url": "http://test3.com{sub2}{sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603485164,
    "relationship": {
        "affiliate": {
            "network_affiliate_id": 7,
            "network_id": 1,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 2,
            "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": 1602783082,
            "time_saved": 1602783082,
            "referrer_id": 0
        }
    },
    "facebook_pixel": null
}

Docs: Reporting

Mon, 01 Jan 0001 00:00:00 +0000

The Everflow UI offers many different types of reports and the API is no different. There is not, however, a one-to-one relationship between every report offered in the UI and the API endpoints as certain API endpoints power many different reports.

Are you looking to fetch all your tracking data? If so, the Firehose might be suited for your use case.

Please note that reporting data is subject to Everflow’s data retention policy.

Aggregated Data Reports

Aggregated data reports are reports like :

Offer Reporting
Partner Report
Advertiser Report
Flex Report
Smart Link Report
Daily Report

in the Everflow UI. They allow you to pivot your data based on the columns of your choice while also applying filters to narrow down the scope of the data returned.

The endpoints that power these reports will allow you to pull data similar to this in the UI

View the aggregated data reports documentation

Aggregated data from the Offer Report

Dashboard Stats

The endpoints documented here power the cards that appear on the dashboard of the Everflow UI after you login.

While these endpoints are not as powerful or granular as the aggregated data reports, they can be useful to quickly pull summaries.

View the dashboard stats documentation

Raw Clicks

These endpoints allow you to pull unaggregated data where each click is a “row” of data.

A set of clicks can be pulled at once and each click row will contain details about the event (device information, geolocation, query parameters). The set of clicks pulled can be filtered based on different criterias (offer, partner, sub id value, etc.)

The endpoints documented in this section power the Click Report as well as the Flowchart in the Everflow UI.

View the raw clicks documentation

Invalid Clicks

The endpoints allow you to pull unaggregated invalid click data where each invalid click is a “row” of data.

The endpoints documented in this section power the Invalid Click Report in the Everflow UI.

View the invalid click documentation

Raw Conversions

The endpoints allow you to pull unaggregated conversion data where each conversion is a “row” of data.

The set of conversion pulled will contain detailed information about each conversion (payout / revenue information, adv values, geolocation, etc.). The set of conversions pulled can be filtered based on different criterias (offer, partner, country, etc.)

Although it is referred to as the “conversion” report, post-conversion events are also returned by this endpoint.

The conversions can also be extracted in CSV format, effectively mimicking the export functionality from the UI.

View the raw conversions documentation

Raw Impressions

Similar in functionality to the raw clicks report, the endpoint will let you pull raw impressions where each impression is a “row” of data.

Note that this endpoint will only be available if the impression package is activated on your Everflow account.

View the raw impressions documentation

Event Report

The endpoint that powers the Event Report in the Everflow UI. Although “events” can also be extracted from the raw conversions endpoints, the Event report aggregates the statistics per event.

View the event report documentation

Affiliate Postback Report

The endpoint that powers the affiliate postback report in the Everflow UI. This will give you a non-aggregated list of affiliate postbacks over a period of time with the optional use of filters.

View the affiliate postback report documentation

Data Supplements

This suite of endpoints allows you to manage reporting adjustments, also known as supplements. Use these to manually inject, fetch, or revert aggregated data, such as offline conversions or financial corrections—to ensure your reporting is reconciled and accurate.

Note that supplements do not alter raw reporting data but instead provide a corrective layer that can be seen on the aggregated reporting data.

View the data supplements documentation

Raw On Hold Conversions

The endpoints allow you to pull unaggregated on hold conversion data where each on hold conversion is a “row” of data.

The set of on hold conversion pulled will contain detailed information about each on hold conversion (revenue information, etc.). The set of on hold conversions pulled can be filtered based on different criterias (offer, country, etc.)

Although it is referred to as the “on hold conversion” report, post-conversion events are also returned by this endpoint.

View the raw on hold conversions documentation

Docs: Sign Up

Mon, 01 Jan 0001 00:00:00 +0000

The Everflow platform offers a way for new Users to sign up in the UI. However, some organizations prefer hosting the signup page on their own website and submit the result to Everflow via the API.

The endpoints described here will help you achieve that.

The payloads submitted will mimic what a user would enter when using the signup form available on Everflow which is documented here.

New Users must have an email address that is unique among all users of the same “type” (Two Partner Users cannot have the same email address, but a Partner User can have the same email address as an Advertiser User).

Note that the content of the payload will be validated. For example, the address submitted must have a valid country, etc.

Custom signup fields (which are optional and defined in Control Center > Configuration > UI Customization), can be used to submit custom signup data on this endpoint. If they are marked as mandatory in Everflow, signups submitted via the API that do not contain the mandatory custom fields will result in an error.

POST /v1/networks/affiliate/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/affiliateportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

If the option is enabled at the network level, billing details can also be passed during the signup.

Signup links on Everflow can contain embedded information about:

The Partner Manager that will be responsible for the new Partner account
The Partner that referred New Partner

These values are encoded in the link. If used they must be submitted the same way in the payload as shown in the second example below. You can use the Encode / Decode endpoints to extract the numeric values if needed.

Body Params

Note that you can determine which fields are required / optional for your account. Visit Control Center > Configuration > UI Customization > Partner Signup to manage the settings.

firstname string

The first name of the affiliate user signing up

lastname string

The last name of the affiliate user signing up

email string

The email address of the user signing up. Must be unique

phone string

Phone number

legal_type string

The affiliate’s entity legal type. Can be one of the following values: individual, partnership, corporation, sole_proprietorship, other, foreign, llc, llp, non_profit, non_us_entity.

company string

The affiliate’s company name. Will become the name property once / if the affiliate is approved.

website string

The affiliate’s website

advertise_method_description string

Method used by the affiliate to advertise

custom_terms string

Network defined custom terms and conditions that the affiliate accepted.

platform_terms string

Everflow’s terms and conditions that the affiliate accepted.

contact_address object

The affiliate’s contact address information. Only required if “is_contact_address_enabled” is set to true.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

referral_code string

Referral code used by the affiliate

tax_id string

Affiliate’s tax ID (used for billing)

affiliate_manager_encoded_value string

Affiliate manager’s encoded ID

referrer_encoded_value string

Encoded value of the affiliate ID that referred the new sign up

billing object

The affiliate’s billing information.

View Object Details Hide Object Details

payment_type string

The affiliate’s payment type. Can be one of the following values: none, pay, paypal, check, wire, direct_deposit, tipalti, payum, veem, payoneer, bitcoin, webmoney, capitalist, transferwise, gift_card, masspay or skrill

billing object

The affiliate’s payment method details. Required when “payment_type” is set to anything else than “none”.

View Object Details Hide Object Details

paxum_id string

The affiliate’s paxum id. Required when “payment_type” is set to “paxum”.

paypal_reception_method string

The reception method used with Paypal. Can be either “email”, “phone” or “paypal_account”. Required when “payment_type” is set to “paypal”.

reception_identifier string

The affiliate’s paypal reception identifier. Required when “payment_type” is set to “paypal”.

email string

The affiliate’s email. Required when “payment_type” is set to “payoneer” or “veem”.

is_existing_payee boolean

Whether you want to assign an existing payee id to this affiliate. Required when “payment_type” is set to “tipalti”.

idap string

The payee’s IDAP (Payee ID). Required when “payment_type” is set to “tipalti” and is_existing_payee is set to true.

first_name string

The affiliate’s first name. Required when “payment_type” is set to “veem”.

last_name string

The affiliate’s last name. Required when “payment_type” is set to “veem”.

phone string

The affiliate’s phone number, must be international format. Required when “payment_type” is set to “veem”.

country_iso string

The affiliate’s country ISO code. Required when “payment_type” is set to “veem”.

bank_name string

The affiliate’s bank name. Required when “payment_type” is set to “wire” or “direct_deposit”.

bank_address string

The affiliate’s bank address. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_name string

The affiliate’s bank account name. Required when “payment_type” is set to “wire” or “direct_deposit”.

account_number string

The affiliate’s bank account number. Required when “payment_type” is set to “wire” or “direct_deposit”.

routing_number string

The affiliate’s bank routing number. Required when “payment_type” is set to “wire” or “direct_deposit”.

swift_code string

The affiliate’s swift code. Required when “payment_type” is set to “wire” or “direct_deposit”.

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/affiliate/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A basic signup request would look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to>",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    }
}

A more complete request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to>",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "referral_code": "facebook",
    "tax_id" : "...",
    "billing":
    {
        "payment_type": "paypal",
        "billing":
        {
            "paypal_reception_method": "paypal_account",
            "reception_identifier": "user@example.com"
        }
    },
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ],
    "affiliate_manager_encoded_value": "RNK3G2",
    "referrer_encoded_value": "RNK3G2"
}

POST /v1/networks/advertiser/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/advertiserportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

Body Params

Note that you can determine which fields are required / optional for your account. Visit Control Center > Configuration > UI Customization > Partner Signup to manage the settings.

firstname string

The first name of the advertiser user signing up

lastname string

The last name of the advertiser user signing up

email string

The email address of the user signing up. Must be unique

phone string

Phone number

company string

The advertiser’s company name. Will become the name property once / if the advertiser is approved.

website string

The advertiser’s website

contact_address object

The advertisers’s contact address information.

View Object Details Hide Object Details

address_1 string

The address first line

address_2 string

The address second line

city string

The city name

region_code string

The region code. Can be found using the metadata API.

country_code string

The country code. Can be found using the metadata API.

zip_postal_code string

The ZIP or Postal code.

referral_code string

Referral code used by the advertiser

tax_id string

Advertiser’s tax ID (used for billing)

account_manager_encoded_value string

Encoded value of the advertiser’s account manager ID

offer_landing_page string

Example of an offer landing page / product page

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/advertiser/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A signup request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "company": "Example company",
    "website": "http://example-website.com",
    "offer_landing_page": "example landing page",
    "referral_code": "facebook",
    "account_manager_encoded_value": "RNK3G2",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ]
}

Docs: Smart Links

Mon, 01 Jan 0001 00:00:00 +0000

Find All

GET /v1/networks/campaigns

Filters

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

Relationships

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

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

Value	Description
reporting	Includes the campaign’s reporting for today
redirects	Includes the campaign’s redirects
offers	Includes the campaign’s list of offers used in the redirects
catch_all_offer_basic	Includes the campaign’s catch-all offer

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/campaigns?relationship=redirects' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "campaigns":
    [
        {
            "network_campaign_id": 1,
            "network_id": 1,
            "campaign_name": "Example SmartLink",
            "campaign_status": "active",
            "network_tracking_domain_id": 1,
            "is_use_secure_link": true,
            "redirect_routing_type": "priority",
            "catch_all_network_offer_id": 775,
            "is_open_to_affiliates": true,
            "run_frequency": "unknown",
            "metric": "unknown",
            "optimization_goal": 0,
            "data_lookback_window": "unknown",
            "data_collection_threshold": 0,
            "time_created": 1633017537,
            "time_saved": 1633017604,
            "relationship":
            {
                "redirects":
                {
                    "total": 2,
                    "entries":
                    [
                        {
                            "network_campaign_redirect_id": 1,
                            "network_campaign_id": 1,
                            "redirect_network_offer_id": 10,
                            "redirect_network_offer_url_id": 0,
                            "routing_value": 1
                        },
                        {
                            "network_campaign_redirect_id": 2,
                            "network_campaign_id": 1,
                            "redirect_network_offer_id": 3,
                            "redirect_network_offer_url_id": 0,
                            "ruleset":
                            {
                                "network_id": 1,
                                "network_ruleset_id": 774,
                                "time_created": 1633017537,
                                "time_saved": 1633017537,
                                "countries":
                                [
                                    {
                                        "network_id": 1,
                                        "network_targeting_country_id": 156,
                                        "country_id": 36,
                                        "label": "Canada",
                                        "country_code": "CA",
                                        "targeting_type": "include",
                                        "match_type": "exact"
                                    }
                                ]
                            },
                            "routing_value": 2,
                        }
                    ]
                },
                "labels":
                {
                    "total": 2,
                    "entries":
                    [
                        "label1",
                        "label2"
                    ]
                },
                "encoded_value": "27W1G"
            }
        }
    ]
}

Find By ID

GET /v1/networks/campaigns/:campaignId

Path Parameters

Parameter	Description
campaignId	The ID of the campaign you want to fetch

Relationships

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

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

Value	Description
reporting	Includes the campaign’s reporting for today
redirects	Includes the campaign’s redirects
offers	Includes the campaign’s list of offers used in the redirects
catch_all_offer_basic	Includes the campaign’s catch-all offer

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/campaigns/1?relationship=redirects' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

 {
  "network_campaign_id": 1,
  "network_id": 1,
  "campaign_name": "Example SmartLink",
  "campaign_status": "active",
  "network_tracking_domain_id": 1,
  "is_use_secure_link": true,
  "redirect_routing_type": "priority",
  "catch_all_network_offer_id": 775,
  "is_open_to_affiliates": true,
  "run_frequency": "unknown",
  "metric": "unknown",
  "optimization_goal": 0,
  "data_lookback_window": "unknown",
  "data_collection_threshold": 0,
  "time_created": 1633017537,
  "time_saved": 1633017604,
  "relationship": {
    "redirects": {
      "total": 2,
      "entries": [
        {
          "network_campaign_redirect_id": 1,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 2601,
          "redirect_network_offer_url_id": 0,
          "routing_value": 1
        },
        {
          "network_campaign_redirect_id": 2,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 3,
          "redirect_network_offer_url_id": 0,
          "ruleset": {
            "network_id": 1,
            "network_ruleset_id": 774,
            "time_created": 1633017537,
            "time_saved": 1633017537,
            "countries": [
              {
                "network_id": 1,
                "network_targeting_country_id": 156,
                "country_id": 36,
                "label": "Canada",
                "country_code": "CA",
                "targeting_type": "include",
                "match_type": "exact"
              }
            ]
          },
          "routing_value": 2,
        }
      ]
    },
    "labels": {
      "total": 2,
      "entries": [
        "label1",
        "label2"
      ]
    },
    "encoded_value": "27W1G"
  }
}

Create

POST /v1/networks/campaigns

Body Params

campaign_name string

The displayed name of the smart link.

campaign_status string

Status of the smart link. Can be one of the following values: active , paused , deleted

network_tracking_domain_id int

The ID of the domain to be used in the affiliate tracking link.

is_use_secure_link boolean

Whether or not you want to force SSL. Improves tracking and security by setting tracking links to always use the more secure https:// instead of http:// .

redirect_routing_type string

The redirect mechanism of the campaign. Determines how the Smart Link traffic is distributed between the listed offers. KPI allows you to automatically deliver traffic ranked in order of the best performing offers for your set KPI. Priority means the first position will be checked, and if the user doesn’t match the offer’s targeting/cap, then it will continue downwards towards the next eligible offer. Choosing Weight will deliver traffic with a percentage split between eligible offers. Can be one of the following values: priority , weight , kpi .

catch_all_network_offer_id int

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if partner has access to the offer and the click can’t be matched with any of the offers in the redirect tree.

is_open_to_affiliates boolean

Whether or not you want to make the campaign visible to affiliates. If this option is enabled, the Smart Link will be visible to the partner only if all the offers are runnable by the partner.

run_frequency string

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Can be one of the following values: 12_hours , 24_hours . Required if redirect_routing_type is set to kpi .

metric string

The metric to use with the KPI campaign. The highest performing offers for your selected metric will be re-ranked towards receiving the majority of the Smart Link traffic. Can be one of the following values: profit , cvr , evr , conversions , payout , revenue . Required if redirect_routing_type is set to kpi .

optimization_goal int

This optimizes ranking towards the offers that are closest towards your set Specific Goal. Required if redirect_routing_type is set to kpi .

data_lookback_window string

Determines the period of data being used for determining how offers are performing at your set Metric. Can be one of the following values: 12_hours , 24_hours , 48_hours . Required if redirect_routing_type is set to kpi .

data_collection_threshold int

The amount of data required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi .

redirects object array

The list of offers that are part of the campaign.

View Object Details Hide Object Details

redirect_network_offer_id int

The ID of the offer.

redirect_network_offer_url_id int

The ID of an offer URL. Defaults to the Base Destination URL.

ruleset object

List of rules for which the redirect applies. See the ruleset object.

routing_value int

The value used to determine the priority or the weight of the offer in the list. Required if redirect_routing_type is set to priority or weight .

labels string array

The list of labels associated with the campaign.

Payload Example

{
    "network_tracking_domain_id": 1,
    "campaign_status": "active",
    "catch_all_network_offer_id": 1,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "is_use_secure_link": true,
    "is_open_to_affiliates": false,
    "campaign_name": "test",
    "redirects":
    [
        {
            "redirect_network_offer_id": 3,
            "routing_value": 1,
                    "redirect_network_offer_url_id": 0,
            "ruleset":
            {
                "countries":
                [
                    {
                        "targeting_type": "include",
                        "match_type": "exact",
                        "country_id": 227
                    }
                ]
            }
        },
        {
            "redirect_network_offer_id": 775,
            "routing_value": 2,
            "redirect_network_offer_url_id": 0
        }
    ],
    "redirect_routing_type": "priority"
}

Update

PUT /v1/networks/campaigns/:campaignId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter	Description
campaignId	The ID of the smart link you want to update

Body Params

campaign_name string

The displayed name of the smart link.

campaign_status string

Status of the smart link. Can be one of the following values: active , paused , deleted

network_tracking_domain_id int

The ID of the domain to be used in the affiliate tracking link.

is_use_secure_link boolean

Whether or not you want to force SSL. Improves tracking and security by setting tracking links to always use the more secure https:// instead of http:// .

redirect_routing_type string

catch_all_network_offer_id int

is_open_to_affiliates boolean

Whether or not you want to make the campaign visible to affiliates. If this option is enabled, the Smart Link will be visible to the partner only if all the offers are runnable by the partner.

run_frequency string

metric string

optimization_goal int

This optimizes ranking towards the offers that are closest towards your set Specific Goal. Required if redirect_routing_type is set to kpi .

data_lookback_window string

data_collection_threshold int

The amount of data required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi .

redirects object array

The list of offers that are part of the campaign.

View Object Details Hide Object Details

redirect_network_offer_id int

The ID of the offer.

redirect_network_offer_url_id int

The ID of an offer URL. Defaults to the Base Destination URL.

ruleset object

List of rules that apply to the redirect. See the ruleset object.

routing_value int

The value used to determine the priority or the weight of the offer in the list. Required if redirect_routing_type is set to priority or weight .

labels string array

The list of labels associated with the campaign.

Payload Example

{
    "network_campaign_id": 1,
    "network_id": 1,
    "campaign_name": "Updated Smartlink",
    "campaign_status": "active",
    "network_tracking_domain_id": 1,
    "is_use_secure_link": true,
    "redirect_routing_type": "priority",
    "catch_all_network_offer_id": 10,
    "is_open_to_affiliates": true,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "labels":
    [
        "label1",
        "label2"
    ],
    "redirects":
    [
        {
            "redirect_network_offer_id": 3,
            "routing_value": 1,
            "ruleset":
            {
                "countries":
                [
                    {
                        "targeting_type": "include",
                        "match_type": "exact",
                        "country_id": 227
                    }
                ]
            }
        },
        {
            "redirect_network_offer_id": 775,
            "routing_value": 2,
            "redirect_network_offer_url_id": 0
        }
    ]
}

Docs: Tracking Links

Mon, 01 Jan 0001 00:00:00 +0000

The endpoints documented here allow you to generate tracking links for offers and smartlinks.

Generate Offer Tracking Link

POST /v1/networks/tracking/offers/clicks

This endpoint will create a click tracking link for a given offer / affiliate couple. The affiliate must have visibility over the offer and must be allowed to “run” the offer. Otherwise the endpoint will return an error.

A lot like the tracking link widget, this endpoint takes many options if you want to e.g. generate a tracking link with a preset sub id. However only the network_offer_id and network_affiliate_id parameters are required.

Body Params

network_offer_id int

The ID of the offer

network_affiliate_id int

The ID of the affiliate

network_tracking_domain_id int

An optional ID for a specific tracking domain that should be used to generate the link

network_offer_url_id int

An optional offer URL ID. If specified, the offer URL ID must belong to the network_offer_id specified (and must exist).

creative_id int

An optional offer creative ID. If specified, the creative must belong to the network_offer_id specified (and must exist).

network_traffic_source_id int

An optional traffic source ID. Note that if a traffic source is associated with the affiliate, this parameter will be ignored and the default traffic source for the affiliate will be used instead.

source_id string

An optional source_id that should be used as a query string parameter on the tracking link.

sub1 string

An optional sub1 that should be used as a query string parameter on the tracking link.

sub2 string

An optional sub2 that should be used as a query string parameter on the tracking link.

sub3 string

An optional sub3 that should be used as a query string parameter on the tracking link.

sub4 string

An optional sub4 that should be used as a query string parameter on the tracking link.

sub5 string

An optional sub5 that should be used as a query string parameter on the tracking link.

is_encrypt_parameters bool

When enabled, will encrypt all query string parameters into a single one.

is_redirect_link bool

Only relevant for direct linking offers. Can be used to override the default setting of the offer and generate a redirect link even on a direct linking offer.

Examples

curl --request POST 'https://api.eflow.team/v1/networks/tracking/offers/clicks' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch a tracking link for offer ID 5 and affiliate ID 7

{
  "network_affiliate_id": 7,
  "network_offer_id": 5
}

Example 2 : Fetch a tracking link for offer ID 1 and affiliate ID 3, using facebook as a sub1 value and media_buying as a sub3 with encrypted parameters.

{
  "network_affiliate_id": 3,
  "network_offer_id": 1,
  "sub1": "facebook",
  "sub3": "media_buying",
  "is_encrypt_parameters": true
}

Response

{
	"url": "http://www.tracking-domain.test/9W598/2CTPL/?sub1=facebook&sub3=media_buying"
}

Generate Offer Tracking Link QR Code

POST /v1/networks/tracking/offers/clicks/qr

This endpoint is effectively the same as the one documented above, but instead of returning a textual version of the tracking link URL, it returns a QR code that points to the tracking link URL.

The body parameters and requirements are the same, only the response differs.

Note that this is a streaming endpoint and that the response will have the Content-Type header set to image/png

Body Params

network_offer_id int

The ID of the offer

network_affiliate_id int

The ID of the affiliate

network_tracking_domain_id int

An optional ID for a specific tracking domain that should be used to generate the link

network_offer_url_id int

An optional offer URL ID. If specified, the offer URL ID must belong to the network_offer_id specified (and must exist).

creative_id int

An optional offer creative ID. If specified, the creative must belong to the network_offer_id specified (and must exist).

network_traffic_source_id int

An optional traffic source ID. Note that if a traffic source is associated with the affiliate, this parameter will be ignored and the default traffic source for the affiliate will be used instead.

source_id string

An optional source_id that should be used as a query string parameter on the tracking link.

sub1 string

An optional sub1 that should be used as a query string parameter on the tracking link.

sub2 string

An optional sub2 that should be used as a query string parameter on the tracking link.

sub3 string

An optional sub3 that should be used as a query string parameter on the tracking link.

sub4 string

An optional sub4 that should be used as a query string parameter on the tracking link.

sub5 string

An optional sub5 that should be used as a query string parameter on the tracking link.

is_encrypt_parameters bool

When enabled, will encrypt all query string parameters into a single one.

is_redirect_link bool

Only relevant for direct linking offers. Can be used to override the default setting of the offer and generate a redirect link even on a direct linking offer.

Examples

curl --request POST 'https://api.eflow.team/v1/networks/tracking/offers/clicks/qr' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch a tracking link for offer ID 5 and affiliate ID 7

{
  "network_affiliate_id": 7,
  "network_offer_id": 5
}

Example 2 : Fetch a tracking link for offer ID 1 and affiliate ID 3, using facebook as a sub1 value and media_buying as a sub3 with encrypted parameters.

{
  "network_affiliate_id": 3,
  "network_offer_id": 1,
  "sub1": "facebook",
  "sub3": "media_buying",
  "is_encrypt_parameters": true
}

Response

The response will be *.png image file streamed back. The result can be saved directly following the curl call. For example :

curl --request POST 'https://api.eflow.team/v1/networks/tracking/offers/clicks/qr' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "network_affiliate_id": 7,
  "network_offer_id": 5
}' > file_qrcode.png

would work.

Generate Smartlink Tracking Link

POST /v1/networks/tracking/campaigns/clicks

This endpoint will create a click tracking link for a given smartlink / affiliate couple.

A lot like the tracking link widget, this endpoint takes many options if you want to e.g. generate a tracking link with a preset sub id. However only the network_campaign_id and network_affiliate_id parameters are required.

Body Params

network_campaign_id int

The ID of the smartlink

network_affiliate_id int

The ID of the affiliate

network_traffic_source_id int

An optional traffic source ID. Note that if a traffic source is associated with the affiliate, this parameter will be ignored and the default traffic source for the affiliate will be used instead.

network_tracking_domain_id int

An optional ID for a specific tracking domain that should be used to generate the link

source_id string

An optional source_id that should be used as a query string parameter on the tracking link.

sub1 string

An optional sub1 that should be used as a query string parameter on the tracking link.

sub2 string

An optional sub2 that should be used as a query string parameter on the tracking link.

sub3 string

An optional sub3 that should be used as a query string parameter on the tracking link.

sub4 string

An optional sub4 that should be used as a query string parameter on the tracking link.

sub5 string

An optional sub5 that should be used as a query string parameter on the tracking link.

is_encrypt_parameters bool

When enabled, will encrypt all query string parameters into a single one.

is_redirect_link bool

Only relevant for direct linking offers. Can be used to override the default setting of the offer and generate a redirect link even on a direct linking offer.

Examples

curl --request POST 'https://api.eflow.team/v1/networks/tracking/campaigns/clicks' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch a tracking link for smartlink ID 5 and affiliate ID 7

{
  "network_affiliate_id": 7,
  "network_campaign_id": 5
}

Example 2 : Fetch a tracking link for smartlink ID 1 and affiliate ID 3, using facebook as a sub1 value and media_buying as a sub3 with encrypted parameters.

{
  "network_affiliate_id": 3,
  "network_campaign_id": 1,
  "sub1": "facebook",
  "sub3": "media_buying",
  "is_encrypt_parameters": true
}

Response

{
	"url": "http://www.servetrack2.test/cmp/5TMX8/27W1G/?sub1=facebook&sub3=media_buying",
	"can_affiliate_run_all_offers": true
}

Generate Smartlink Tracking Link QR Code

POST /v1/networks/tracking/campaigns/clicks/qr

This endpoint is effectively the same as the one documented above, but instead of returning a textual version of the tracking link URL, it returns a QR code that points to the tracking link URL.

The body parameters and requirements are the same, only the response differs.

Note that this is a streaming endpoint and that the response will have the Content-Type header set to image/png

Body Params

network_campaign_id int

The ID of the smartlink

network_affiliate_id int

The ID of the affiliate

network_traffic_source_id int

An optional traffic source ID. Note that if a traffic source is associated with the affiliate, this parameter will be ignored and the default traffic source for the affiliate will be used instead.

network_tracking_domain_id int

An optional ID for a specific tracking domain that should be used to generate the link

source_id string

An optional source_id that should be used as a query string parameter on the tracking link.

sub1 string

An optional sub1 that should be used as a query string parameter on the tracking link.

sub2 string

An optional sub2 that should be used as a query string parameter on the tracking link.

sub3 string

An optional sub3 that should be used as a query string parameter on the tracking link.

sub4 string

An optional sub4 that should be used as a query string parameter on the tracking link.

sub5 string

An optional sub5 that should be used as a query string parameter on the tracking link.

is_encrypt_parameters bool

When enabled, will encrypt all query string parameters into a single one.

is_redirect_link bool

Only relevant for direct linking offers. Can be used to override the default setting of the offer and generate a redirect link even on a direct linking offer.

Examples

curl --request POST 'https://api.eflow.team/v1/networks/tracking/campaigns/clicks/qr' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch a tracking link for smartlink ID 5 and affiliate ID 7

{
  "network_affiliate_id": 7,
  "network_campaign_id": 5
}

Example 2 : Fetch a tracking link for smartlink ID 1 and affiliate ID 3, using facebook as a sub1 value and media_buying as a sub3 with encrypted parameters.

{
  "network_affiliate_id": 3,
  "network_campaign_id": 1,
  "sub1": "facebook",
  "sub3": "media_buying",
  "is_encrypt_parameters": true
}

Response

The response will be *.png image file streamed back. The result can be saved directly following the curl call. For example :

curl --request POST 'https://api.eflow.team/v1/networks/tracking/campaigns/clicks/qr' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "network_affiliate_id": 7,
  "network_campaign_id": 5
}' > file_qrcode.png

would work.