Everflow –

Docs: Advertiser Webhooks

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

Advertiser webhooks are fired whenever advertisers are created or updated.

Advertiser Created

This is only fired when an advertiser is created at a top level. Creating a new advertiser user for an existing advertiser for example will not cause this webhook to fire.

The payload included in the Advertiser Created webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using both the users and billing relationships.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_advertiser_id": 166,
    "network_id": 1,
    "name": "New Advertiser",
    "account_status": "active",
    "network_employee_id": 152,
    "internal_notes": "Internal Notes",
    "address_id": 83933,
    "is_contact_address_enabled": true,
    "sales_manager_id": 132,
    "is_expose_publisher_reporting_data": null,
    "default_currency_id": "USD",
    "platform_name": "Patform Name",
    "platform_url": "www.platform-example.com",
    "platform_username": "adv_name",
    "reporting_timezone_id": 67,
    "accounting_contact_email": "",
    "verification_token": "Cpzx7BXU3X6BerBKtokdD0LmlB5m33",
    "offer_id_macro": "oid",
    "affiliate_id_macro": "affid",
    "time_created": 1609951948,
    "time_saved": 1609951948,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "labelx",
                "labely"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_advertiser_user_id": 59,
                    "network_id": 1,
                    "network_advertiser_id": 166,
                    "first_name": "Advertiser",
                    "last_name": "User",
                    "email": "advertiser-user@example.com",
                    "title": "Title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 1,
                    "instant_messaging_identifier": "advertiser.user",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609951948,
                    "time_saved": 1609951948
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "integrations": {
            "optizmo": {
                "iframe_url": "https://one.optizmo.net/api?action=manage_optoutlists"
            },
            "advertiser_demand_partner": null
        },
        "contact_address": {
            "address_id": 83933,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 200",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "billing": {
            "network_id": 1,
            "network_advertiser_id": 166,
            "billing_frequency": "monthly",
            "invoice_amount_threshold": 500,
            "tax_id": "Tax ID",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2021-01-01 00:00:00",
            "default_invoice_is_hidden": true,
            "invoice_generation_days_delay": 7,
            "default_payment_terms": 15,
            "relationship": {
                "monthly": {
                    "day_of_month": 26
                }
            }
        },
        "sale_manager": {
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        }
    },
    "attribution_method": "last_touch",
    "email_attribution_method": "last_affiliate_attribution"
}

Advertiser Updated

This is only fired when the advertiser itself is updated. For example it will be fired when :

The account manager of the advertiser is changed to a different one
The advertiser’s address is updated
The advertiser’s billing settings are modified

It will not be fired when :

A partner is added to the advertiser’s blacklist
New link templates are added for the advertiser
An advertiser user is created or updated

The payload included in the Advertiser Updated webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using both the users and billing relationships.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_advertiser_id": 166,
    "network_id": 1,
    "name": "Updated Advertiser",
    "account_status": "active",
    "network_employee_id": 152,
    "internal_notes": "Internal Notes",
    "address_id": 83933,
    "is_contact_address_enabled": true,
    "sales_manager_id": 132,
    "is_expose_publisher_reporting_data": null,
    "default_currency_id": "USD",
    "platform_name": "Patform Name",
    "platform_url": "www.platform-example.com",
    "platform_username": "adv_name",
    "reporting_timezone_id": 67,
    "accounting_contact_email": "",
    "verification_token": "Cpzx7BXU3X6BerBKtokdD0LmlB5m33",
    "offer_id_macro": "oid",
    "affiliate_id_macro": "affid",
    "time_created": 1609951948,
    "time_saved": 1609952074,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "labelx",
                "labely"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_advertiser_user_id": 59,
                    "network_id": 1,
                    "network_advertiser_id": 166,
                    "first_name": "Advertiser",
                    "last_name": "User",
                    "email": "advertiser-user@example.com",
                    "title": "Title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 1,
                    "instant_messaging_identifier": "advertiser.user",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609951948,
                    "time_saved": 1609951948
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "integrations": {
            "optizmo": {
                "iframe_url": "https://one.optizmo.net/api?action=manage_optoutlists"
            },
            "advertiser_demand_partner": null
        },
        "contact_address": {
            "address_id": 83933,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 200",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "billing": {
            "network_id": 1,
            "network_advertiser_id": 166,
            "billing_frequency": "monthly",
            "invoice_amount_threshold": 500,
            "tax_id": "Tax ID",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2021-01-01 00:00:00",
            "default_invoice_is_hidden": true,
            "invoice_generation_days_delay": 7,
            "default_payment_terms": 15,
            "relationship": {
                "monthly": {
                    "day_of_month": 26
                }
            }
        },
        "sale_manager": {
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        }
    },
    "attribution_method": "last_touch",
    "email_attribution_method": "last_affiliate_attribution"
}

Advertiser Signed Up

This is only fired when the advertiser signs up themself using the advertiser signup form.

This webhook will not fire when the advertiser is created manually inside the Everflow UI.

The payload included in the Advertiser Signed Up webhook is the same one you would receive by making a request to the Find Advertiser By ID endpoint using the users, billing and signup relationships.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_advertiser_id": 263,
    "network_id": 5,
    "name": "Example Advertiser",
    "account_status": "pending",
    "network_employee_id": 32,
    "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": 90,
    "accounting_contact_email": "",
    "verification_token": "",
    "offer_id_macro": "oid",
    "affiliate_id_macro": "affid",
    "time_created": 1696551758,
    "time_saved": 1696551758,
    "relationship":
    {
        "labels":
        {
            "total": 0,
            "entries": []
        },
        "users":
        {
            "total": 1,
            "entries":
            [
                {
                    "network_advertiser_user_id": 113,
                    "network_id": 5,
                    "network_advertiser_id": 263,
                    "first_name": "John",
                    "last_name": "Doe",
                    "email": "john.doe@example.com",
                    "title": "",
                    "work_phone": "",
                    "cell_phone": "",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 90,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1696551758,
                    "time_saved": 1696551758
                }
            ]
        },
        "account_manager":
        {
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "jane.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "integrations":
        {
            "optizmo":
            {
                "iframe_url": "https://some.url.com"
            },
            "advertiser_demand_partner": null
        },
        "billing":
        {
            "network_id": 5,
            "network_advertiser_id": 263,
            "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": {}
        },
        "sign_up":
        {
            "network_advertiser_id": 263,
            "website_url": "everflow.io",
            "referral_code": "",
            "user_ip": "1.2.3.4",
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
            "phone": "",
            "tax_id": "",
            "offer_landing_page": "everflow.io",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "time_created": 1696551757,
            "relationship":
            {
                "custom_field_values":
                [
                    {
                        "network_signup_custom_field_id": 1,
                        "network_advertiser_id": 263,
                        "field_value": "Skype"
                    },
                    {
                        "network_signup_custom_field_id": 2,
                        "network_advertiser_id": 263,
                        "field_value": "Facebook"
                    }
                ],
                "custom_fields":
                [
                    {
                        "network_signup_custom_field_id": 1,
                        "network_id": 5,
                        "field_type": "input",
                        "label": "Preferred Communication Method",
                        "field_order": 1,
                        "is_required": true,
                        "time_created": 1600979548,
                        "time_saved": 1696011622,
                        "relationship":
                        {
                            "input":
                            {
                                "placeholder": "",
                                "min_length": 0,
                                "max_length": 0,
                                "prefix": ""
                            }
                        },
                        "tooltip": "",
                        "section": ""
                    },
                    {
                        "network_signup_custom_field_id": 2,
                        "network_id": 5,
                        "field_type": "input",
                        "label": "Traffic Source ",
                        "field_order": 2,
                        "is_required": false,
                        "time_created": 1648736950,
                        "time_saved": 1696011622,
                        "relationship":
                        {
                            "input":
                            {
                                "placeholder": "",
                                "min_length": 0,
                                "max_length": 0,
                                "prefix": ""
                            }
                        },
                        "tooltip": "",
                        "section": ""
                    }
                ],
                "mailing_address":
                {
                    "address_id": 84531,
                    "network_id": 5,
                    "address_1": "123 Main Street",
                    "address_2": "",
                    "city": "Beverly Hills",
                    "region_code": "CA",
                    "country_id": 227,
                    "country_code": "US",
                    "zip_postal_code": "90210"
                }
            },
            "language_id": ""
        },
        "sale_manager":
        {
            "first_name": "",
            "last_name": "",
            "email": "",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        }
    },
    "attribution_method": "last_touch",
    "email_attribution_method": "last_affiliate_attribution"
}

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: Aggregated Data Reports

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

Aggregated data reports endpoints are the most powerful reports in the Everflow platform. They power many different reports in the UI and allow you to pull reporting metrics by pivoting your data based on one or multiple columns. Concretely, the report will allow you to, for example, pull all reporting metrics per offer, effectively turning each offer into a reporting “line”.

Using multiple columns like "offer" and "country" would mean that each reporting “line” is a unique couple of offer / country.

The endpoints documented here all support the same columns and can take up to 10 columns in a single request. At least one column must be specified in each request.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

View Columns

Note that you can only use a single time-related column at a time. For example, using both week and hour at the same time won’t work.

Column	Description
offer	Group by offer id
creative	Group by creative id
coupon_code	Group by coupon code
offer_url	Group by offer url
country	Group by country
country_code	Group by country code
region	Group by region
city	Group by city
dma	Group by dma
carrier	Group by carrier
platform	Group by platform
isp	Group by isp
os_version	Group by OS version
device_type	Group by device type
device_model	Group by device model
device_make	Group by device make
browser	Group by browser
language	Group by language
sub1	Group by sub1 (same for sub2-5)
source_id	Group by source id
referer	Group by referer
event_name	Group by event name
connection_type	Group by connection type
tracking_domain	Group by tracking domain
hour	Group by hour
date	Group by date
week	Group by week
month	Group by month
year	Group by year

Table

POST /v1/affiliates/reporting/entity/table

The main endpoint on which you can pivot your data. Each request must contain :

from and to dates
timezone_id used for the request. Find all timezones here
currency_id used for the reporting metrics
At least one column

Optional query filters can then be added to the call.

Please note that the endpoint is limited to 10,000 rows. If you hit the limit, response will include "incomplete_results": true in the payload. When that’s the case, either reduce the number of columns or reduce the scope of the report you are requesting.

Query Filters

Query filters allow you to limit the scope of the report returned by the API. You could create a filter to limit the reporting data to a single partner for example. You can use multiple filters in a request.

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, creative, country, country_code, sub1, sub2, sub3, sub4, sub5, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, os_version, coupon_code

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/affiliates/reporting/entity/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Pull all reporting data for the 8th of February 2022 (from midnight until 23h59:59) broken down by offer

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        }
    ],
    "query": {
        "filters": [ ]
    }
}

Example 2 : Pull all reporting data for the 8th of February 2022 (from midnight until 23h59:59) for offer IDs 882 and 883

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        }
    ],
    "query": {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ],
    }
}

Example 3 : Include only traffic that comes from the US or Canada and that has the "internal" value passed as a sub1. Break the data down by device type

{
    "from": "2022-02-01",
    "to": "2022-02-07",
    "timezone_id": 90,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "device_type"
        }
    ],
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "internal",
                "resource_type": "sub1"
            },
            {
                "filter_id_value": "Canada",
                "resource_type": "country"
            },
            {
                "filter_id_value": "United States",
                "resource_type": "country"
            }
        ]
    }
}

Example 4 : Reporting metrics for all smart links currently running, broken down per smart link / destination offer :

{
    "from": "2022-02-01",
    "to": "2022-02-01",
    "timezone_id": 80,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "campaign"
        },
        {
            "column": "offer"
        }
    ],
    "query":
    {
<span style="color:#000;font-weight:bold">}</span>

}

Response

The response from this endpoint varies depending on the columns you requested. The structure will always be the same though, and the reporting metrics included in the response do not vary either.

Given the following request payload :

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "country"
        }
    ]
}

The response would look like :

{
	"table": [
		{
			"columns": [
				{
					"column_type": "offer",
					"id": "3",
					"label": "Example Offer Name"
				},
				{
					"column_type": "country",
					"id": "United States",
					"label": "United States"
				}
			],
			"reporting": {
				"imp": 0,
				"total_click": 27,
				"unique_click": 27,
				"invalid_click": 0,
				"duplicate_click": 0,
				"ctr": 0,
				"cv": 2,
				"view_through_cv": 0,
				"event": 0,
				"cvr": 7.407,
				"evr": 0,
				"rpc": 0.059,
				"rpm": 0,
				"revenue": 1.6,
				"redirect_traffic_revenue": 0
			}
		},
		{
			"columns": [
				{
					"column_type": "offer",
					"id": "3",
					"label": "Example Offer"
				},
				{
					"column_type": "country",
					"id": "Canada",
					"label": "Canada"
				}
			],
			"reporting": {
				"imp": 0,
				"total_click": 10,
				"unique_click": 10,
				"invalid_click": 0,
				"duplicate_click": 0,
				"ctr": 0,
				"cv": 2,
				"view_through_cv": 0,
				"event": 0,
				"cvr": 20,
				"evr": 0,
				"rpc": 0.16,
				"rpm": 0,
				"revenue": 1.6,
				"redirect_traffic_revenue": 0
			}
		}
	]
}

Table Export

POST /v1/affiliates/reporting/entity/table/export

The table export is basically identical to the table endpoint documented above, except that it lets you “export” the data in CSV or JSON format.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Example

curl --request POST 'https://api.eflow.team/v1/affiliates/reporting/entity/table/export' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "country"
        }
    ],
    "query": {
        "filters": [ ]
    },
    "format": "csv"
}'

Docs: Aggregated Data Reports

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

Using multiple columns like "offer" and "affiliate" would mean that each reporting “line” is a unique couple of offer / affiliate.

The endpoints documented here all support the same columns and can take up to 10 columns in a single request. At least one column must be specified in each request.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

View Columns

Note that you can only use a single time-related column at a time. For example, using both week and hour at the same time won’t work.

Column	Description
offer	Group by offer id
affiliate	Group by affiliate id
advertiser	Group by advertiser id
offer_group	Group by offer_group id
campaign	Group by network campaign id
creative	Group by creative id
event_name	Group by event id
offer_url	Group by offer url id
country	Group by country
country_code	Group by country code
region	Group by region
city	Group by city
dma	Group by dma
carrier	Group by carrier
platform	Group by platform
os_version	Group by os version
isp	Group by isp
browser	Group by browser
device_type	Group by device type
device_make	Group by device brand (make)
model	Group by device model
language	Group by language
connection_type	Group by connection type
sub1	Group by sub1 value (same for sub2-5)
source_id	Group by source id
adv1	Group by adv1 value (same for adv2-5)
coupon_code	Group by coupon code
tracking_domain	Group by network tracking domain id
referer	Group by referer
offer_status	Group by offer status
affiliate_manager	Group by affiliate manager id
account_manager	Group by account manager id
category	Group by category id
project_id	Group by project id
payout_type	Group by payout type
payout_amount	Group by payout amount
revenue_type	Group by revenue type
revenue_amount	Group by revenue amount
currency	Group by currency id
sales_manager	Group by sales manager id
account_executive	Group by account executive id
affiliate_status	Group by affiliate status
advertiser_event_name	Group by advertiser global event id
app_identifier	Group by app identifier
bundle_id	Group by bundle id

Table

POST /v1/networks/reporting/entity/table

The main endpoint on which you can pivot your data. Each request must contain :

from and to dates
timezone_id used for the request. Find all timezones here
currency_id used for the reporting metrics
At least one column

Optional query filters can then be added to the call.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Exclusion Filters

Exclusions are similar to query filters, but instead of forcing you to include many different values they allow you to exclude a single entity. Pulling reporting data for all but a single partner for example :

{
  //...
  "query": {
    "exclusions": [
      {
        "filter_id_value": "100",
        "resource_type": "affiliate"
      }
    ]
  }
}

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, account_manager, affiliate_manager, category, billing_frequency, country, country_code, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, offer_status, sub1, sub2, sub3, sub4, sub5, channel, coupon_code, affiliate_tier

Additional Settings

Aggregated data requests also support 3 entirely optional settings :

ignore_fail_traffic : defaults to false when omitted – can be used to exclude fail traffic from results
only_include_fail_traffic : defaults to false – opposite of the setting above
campaign_data_only : defaults to false – the word “campaign” in this context refers to smart links. Turning this on will only return the metrics for traffic that was sent through a smart link.

{
  //...
  "query": {
    "settings": {
      "campaign_data_only": false,
      "ignore_fail_traffic": false,
      "only_include_fail_traffic": false
    }
  }
}

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/reporting/entity/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Pull all reporting data for the 8th of February 2022 (from midnight until 23h59:59) broken down by offer and affiliate

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ],
    "query": {
        "filters": [ ]
    }
}

Example 2 : Include only traffic that comes from the US or Canada and that has the "internal" value passed as a sub1. Break the data down by device type

{
    "from": "2022-02-01",
    "to": "2022-02-07",
    "timezone_id": 90,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "device_type"
        }
    ],
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "internal",
                "resource_type": "sub1"
            },
            {
                "filter_id_value": "Canada",
                "resource_type": "country"
            },
            {
                "filter_id_value": "United States",
                "resource_type": "country"
            }
        ]
    }
}

Example 3 : Reporting metrics per affiliate on 2 offers for all but one affiliate

{
    "from": "2022-02-01",
    "to": "2022-02-02",
    "timezone_id": 90,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "affiliate"
        }
    ],
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ],
        "exclusions":
        [
            {
                "filter_id_value": "1",
                "resource_type": "affiliate"
            }
        ]
    }
}

Example 4 : Reporting metrics for all smart links currently running, broken down per smart link / destination offer :

{
    "from": "2022-02-01",
    "to": "2022-02-01",
    "timezone_id": 80,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "campaign"
        },
        {
            "column": "offer"
        }
    ],
    "query":
    {
        "settings":
        {
            "campaign_data_only": true,
            "ignore_fail_traffic": false
        }
    }
}

Response

The response from this endpoint varies depending on the columns you requested. The structure will always be the same though, and the reporting metrics included in the response do not vary either.

Note that whenever the offer column is requested, the advertiser column is always included in the response on top of the offer column.

The usm_columns and custom_metric_columns will be filled with any user management and custom metrics you created (they are optional).

Given the following request payload :

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ]
}

The response would look like :

{
    "table": [
        {
            "columns": [
                {
                    "column_type": "offer",
                    "id": "879",
                    "label": "Example Offer Name"
                },
                {
                    "column_type": "advertiser",
                    "id": "135",
                    "label": "Example Advertiser Name"
                },
                {
                    "column_type": "affiliate",
                    "id": "20019",
                    "label": "Partner Inc."
                }
            ],
            "reporting": {
                "imp": 0,
                "total_click": 75,
                "unique_click": 75,
                "invalid_click": 7027,
                "duplicate_click": 0,
                "gross_click": 7102,
                "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
            }
        },
        {
            "columns": [
                {
                    "column_type": "offer",
                    "id": "881",
                    "label": "Other Example Offer"
                },
                {
                    "column_type": "advertiser",
                    "id": "135",
                    "label": "Example AdvertiserName"
                },
                {
                    "column_type": "affiliate",
                    "id": "20017",
                    "label": "Other Partner Inc."
                }
            ],
            "reporting": {
                "imp": 0,
                "total_click": 0,
                "unique_click": 0,
                "invalid_click": 2693,
                "duplicate_click": 0,
                "gross_click": 2693,
                "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
            },
            "usm_columns": [],
            "custom_metric_columns": []
        }
    ]
}

Table Export

POST /v1/networks/reporting/entity/table/export

The table export is basically identical to the table endpoint documented above, except that it lets you “export” the data in CSV or JSON format.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Example

curl --request POST 'https://api.eflow.team/v1/networks/reporting/entity/table/export' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ],
    "query": {
        "filters": [ ]
    },
    "format": "csv"
}'

Summary

POST /v1/networks/reporting/entity/summary

The summary endpoint is useful when you are looking to use the powerful features of the table endpoint documented above but you are only looking for top level reporting metrics.

In other words, this endpoint only returns a single reporting metric “row” that will contain the summary of all the data returned by the table endpoint. When using the Everflow UI, you would see this data in the “Summary” section of your report.

While the response from this endpoint is in no way affected by the columns requested, it is still necessary to include them in the request as the endpoint was always intended to be used in conjunction with the table endpoint.

Reporting summary line in the Everflow UI

Example

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/entity/summary \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        }
    ],
    "query": {
        "filters": [ ]
    }
}'

Response

A single reporting metrics entry :

{
  "imp": 0,
  "total_click": 82630,
  "unique_click": 82630,
  "invalid_click": 51484,
  "duplicate_click": 0,
  "gross_click": 134114,
  "ctr": 0,
  "cv": 1150,
  "invalid_cv_scrub": 21,
  "view_through_cv": 0,
  "total_cv": 1171,
  "event": 611,
  "cvr": 1.417,
  "evr": 52.178,
  "cpc": 0.096,
  "cpm": 0,
  "cpa": 6.786,
  "epc": 0.246,
  "rpc": 0.342,
  "rpa": 24.113,
  "rpm": 0,
  "payout": 7946,
  "revenue": 28236.05,
  "event_revenue": 21709.05,
  "gross_sales": 86989,
  "profit": 20290.05,
  "margin": 71.859,
  "roas": 3.081,
  "avg_sale_value": 74.286,
  "media_buying_cost": 0
}

Reporting Adjustments

GET /v1/networks/reportingadjustments

The following endpoint will return all adjustments made to aggregated reporting as well as a snapshot of what the reporting was prior to the adjustment. This can be useful when trying to reconcile differences between the raw reporting data and the values returned from the endpoints above.

The following query parameters are mandatory in the url on this endpoint in the following format.

Value	Description
to	to date in YYYY-MM-DD format and will utilize network’s timezone
from	from date in YYYY-MM-DD format and will utilize network’s timezone

Example

curl --request GET 'https://api.eflow.team/v1/networks/reportingadjustments?to=2025-06-23&from=2025-06-23' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Response

An example in which there is an adjustment of a payout of 0 to a payout of 10.

{
  "adjustments": [
    {
      "network_reporting_adjustment_id": 1,
      "network_id": 5,
      "network_affiliate_id": 20509,
      "network_offer_id": 1522,
      "network_employee_id": 1,
      "total_clicks": 0,
      "unique_clicks": 0,
      "conversions": 1,
      "payout": 10,
      "revenue": 0,
      "date_adjustment": "2025-06-23",
      "notes": "",
      "gross_sales": 0,
      "impressions": 0,
      "media_buying_cost": 0,
      "time_created": 1750800448,
      "time_saved": 1750800448,
      "deleted": false,
      "relationship": {
        "snapshot": {
          "network_reporting_adjustment_id": 1,
          "network_id": 5,
          "network_affiliate_id": 20509,
          "network_offer_id": 1522,
          "total_clicks": 0,
          "unique_clicks": 0,
          "conversions": 1,
          "payout": 0,
          "revenue": 0,
          "event_revenue": 0,
          "gross_sales": 0,
          "impressions": 0,
          "media_buying_cost": 0,
          "snapshot_timestamp": 1750629600,
          "snapshot_date": "2025-06-23",
          "time_created": 1750800448
        }
      }
    }
  ]
}

Docs: Authentication

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

Summary

The Everflow API is organized around REST and uses built-in HTTP features (Verbs, Error Codes, etc.)

The host for all requests is https://api.eflow.team/v1^[1]. All requests must be made over HTTPS.

The JSON format is returned by all API responses, including errors.

[1]: A very small subset of Everflow accounts are hosted on EU servers only. For these accounts the host is `https://api-eu.eflow.team/v1`. Please speak to your account manager if you are unsure if this applies to you.

Making Requests

The Accept header is not required, though you can specify it using Accept : application/json

All requests must be authentified using your API Key (see Authentication section for more details). Requests made without authentication will fail.

Request Body

When submitting data to a resource via POST, PUT or PATCH, you must submit your payload in JSON.

{ "property" : "value" }

Authentication

All requests to the Everflow API must be authenticated using an API key.

To authenticate add a X-Eflow-API-Key header to your request that contains your API Key.

For example :

# Network API
curl -H "X-Eflow-API-Key: --your-api-key--" --url https://api.eflow.team/v1/networks

# Affiliate API
curl -H "X-Eflow-API-Key: --your-api-key--" --url https://api.eflow.team/v1/affiliates/affiliate

# Advertiser API
curl -H "X-Eflow-API-Key: --your-api-key--" --url https://api.eflow.team/v1/advertisers/advertiser

# Marketplace API
curl -H "X-Eflow-API-Key: --your-api-key--" --url https://api.eflow.team/v1/partners

Please note that using an API key for the wrong portal (e.g. using the Affiliate API key to access an Advertiser API endpoint) will result in a 403 error with the error message Out of realm.

API Keys

API Keys are generated directly in the Everflow UI.

Network API Keys

Network API keys are created from the “Security” section of the Control Center.

Each key has its own set of permissions, independant of the user it is associated with :

Note that while the API key name and permissions can be modified after the creation, the API key itself will only be shown once upon its creation and never again. Make sure to keep it somewhere safe and revoke it immediately if you suspect it has been compromised.

Affiliate API Keys

Affiliate API keys are created and managed by the network users. Affiliate users cannot create keys themselves and must rely on a network user to create the key and hand it over. API keys are created under the “API” tab in the Manage Affiliate section :

Advertiser API Keys

Advertiser API keys are also created and managed by the network users. Advertiser users cannot create keys themselves and must rely on a network user to create the key and hand it over. API keys are created under the “API Keys” tab in the Managed Advertiser section :

Marketplace API Keys

Marketplace API keys do not exist by default and must be requested to your account manager.

When a key does exist, it will appear under the API tab of the My Account section :

Docs: Click Tracking

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

The simplest way to start tracking clicks is to generate a click using the following code :

EF.click({
  offer_id: 1, // Required. The offer id
  affiliate_id: 1, //Required. The affiliate id
});

You may wish to add additional data that will be passed along with the click :

EF.click({
  offer_id: 1, // Required. The offer id
  affiliate_id: 1, //Required. The affiliate id

  uid: 5, // Optional : Offer URL Id
  creative_id: 14, // Optional : Offer Creative ID

  // Optional. Sub placement values.
  sub1: '',
  sub2: '',
  sub3: '',
  sub4: '',
  sub5: '',
  source_id: '',

  coupon_code: '...', // Optional Coupon Code at the click level

  fbclid: '...', // Facebook unique click ID
  gclid: '...', // Google unique click ID
  ttclid: '...', // TikTok unique click ID
});

Extracting data from the URL

When working with direct linking, the affiliate id involved in the click will most likely be dynamic and the value will be passed in the query string of the URL.

The Everflow SDK provides a method to extract any value from the URL. In the following example, the script executes on a landing page where the affiliate id is passed using the affid url parameter : https://destination-url.com?affid=5

EF.click({
  offer_id: 1, // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id
});

The EF.urlParameter can be used to extract any query string parameter from the URL. For example if the destination URL was instead : https://destination-url.com?oid=3&affid=5&src=facebook&app=mobile, you could use the following code :

EF.click({
  offer_id: EF.urlParameter('oid'), // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id
  
  sub3: EF.urlParameter('src'), // Optional : "facebook" would be passed as the sub3 in this example
  sub4: EF.urlParameter('app'), // Optional : "mobile" would be passed as the sub4 in this example
  sub5: EF.urlParameter('ref'), // The "ref" query string parameter is missing from the URL. Nothing would be passed as the sub5

});

You can use the Everflow SDK to enhance traditional tracking when you own landing pages. In other words, you can use the Everflow SDK even if you use traditionnal redirect links, which will have the benefit of setting a first-party cookie.

In order to do so, fill the transaction_id parameter when using EF.click. Normally, you would configure your destination url to include the transaction_id, offer_id and affiliate_id macros. Given the following destination url: https://destination-url.com?transaction_id=af189e77650e4e908af797b61b03ac0b&oid=1&affid=5

EF.click({
  offer_id: EF.urlParameter('oid'), 
  affiliate_id: EF.urlParameter('affid'),
  transaction_id: EF.urlParameter('transaction_id')
});

Custom Parameters

It’s also possible to add free form parameters to the click. This is effectively equivalent to adding additional query string parameters to the tracking link URL.

EF.click({
  offer_id: EF.urlParameter('oid'), // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id

  //Optional. Free form parameters to be appended to the click URL
  parameters: {
    "param1" : "customValue1",
    "param2" : "customValue2" 
  }
})

Attribution in Multi-Tenant Scenarios

While the Everflow SDK does support multiple accounts generating clicks on the same page, it’s important to understand that it does present its own set of challenges. The SDK relies on browser features like cookies to store the transaction IDs necessary for attribution.

The SDK was built with single-tenant usage in mind and may require a little custom work in order to attribute conversions to the right click, especially in scenarios where both networks use the same offer ID.

Please read the Domains Configuration page for more details on how to configure the SDK in such scenarios.

The following sections (“Fetching The Transaction ID” and “Extracting The Transaction ID”) should give you enough information to come up with an attribution strategy that works for your multi-tenant scenario.

Advanced Use

Fetching The Transaction ID

Clicks are identified by unique transaction IDs in Everflow. There are scenarios in which it can be useful to make use of that transaction ID immediately after generating a click.

The EF.click method returns a Promise which, when resolved, will give the transaction ID :

EF.click({
  offer_id: EF.urlParameter('oid'), 
  affiliate_id: EF.urlParameter('affid'),
})
.then((transactionId) => {
  // transactionId containts the unique Everflow transaction ID
  console.log(transactionId)
});

Extracting The Transaction ID

It’s also possible to extract the transaction ID of the last click that was generated using EF.click for a given user. This can be useful in scenarios where, for example, the user initially lands on the following URL : https://destination-url.com/page-A?oid=3&affid=5. The click is generated using

EF.click({
  offer_id: EF.urlParameter('oid'), 
  affiliate_id: EF.urlParameter('affid'),
});

If the user later navigates to https://destination-url.com/page-B, you can access the transaction ID by executing

var offerId = 3;
var efTid = EF.getTransactionId(offerId);

The EF.getTransactionId method will return the latest transaction ID found. It will return an empty string if no transaction ID is found.

You can also access the latest transaction id for a specific advertiser ID, regardless of the offer ID.

var advertiserId = 1;
var efTid = EF.getAdvertiserTransactionId(advertiserId)

Conditional Clicks and Parameters

Of course, being able to extract the transaction ID means that you can add some conditional logic around the way your generate your clicks. For example, if you wish to generate a click only when there are no other transaction IDs stored in the user’s browser, you could add the following logic :

var offerId = 3;
var previousTransactionId = EF.getTransactionId(offerId);

if (!previousTransactionId) {
  EF.click({
    offer_id: offerId, 
    affiliate_id: EF.urlParameter('affid'),
  });
} else {
  // The user has already been on this page and already has the previousTransactionId
  // stored in the browser
}

Similarly, there may be situations in which you wish to attribute a click to “default values” if, for example, no offer id or affiliate id is supplied in the URL

var DEFAULT_OFFER_ID = 1;
var DEFAULT_AFFILIATE_ID = 10;

var offerId = EF.urlParameter('oid'); //Try and extract `oid` from the URL
if (!offerId) {
  offerId = DEFAULT_OFFER_ID; //Default to offer ID 1 if nothing was supplied in the URL
}

var affiliateId = EF.urlParameter('affid'); //Try and extract `affid` from the URL
if (!affiliateId) {
  affiliateId = DEFAULT_AFFILIATE_ID; //Default to affiliate ID 10 if nothing was supplied in the URL
}

EF.click({
  offer_id: offerId, 
  affiliate_id: affiliateId,
});

Docs: Offer Webhooks

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

Offer webhooks are fired whenever offers are created or updated.

Offer Created

This is only fired when a offer is created. Creating a new offer URL or a new Smartlink for example will not cause this webhook to fire.

The payload included in the Offer Created webhook is the same one you would receive by making a request to the Find Offer By ID endpoint.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_offer_id": 1019,
    "network_id": 1,
    "network_advertiser_id": 64,
    "network_offer_group_id": 0,
    "name": "New Offer",
    "thumbnail_url": "https://assets.efusercontent.com/1/offers/1019/thumb/example-thumbnail.png",
    "network_category_id": 18,
    "internal_notes": "Internal Notes for the offer",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "server_side_url": "",
    "is_view_through_enabled": false,
    "view_through_destination_url": "",
    "preview_url": "http://preview-url.com",
    "offer_status": "active",
    "currency_id": "USD",
    "caps_timezone_id": 80,
    "project_id": "12345",
    "date_live_until": "2023-01-01",
    "html_description": "<div>Public HTML description visible to partners</div>",
    "is_using_explicit_terms_and_conditions": false,
    "terms_and_conditions": "",
    "is_force_terms_and_conditions": false,
    "is_caps_enabled": true,
    "daily_conversion_cap": 100,
    "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": 50000,
    "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": true,
    "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": true,
    "redirect_routing_method": "internal",
    "redirect_internal_routing_type": "priority",
    "visibility": "require_approval",
    "time_created": 1609459200,
    "time_saved": 1609459200,
    "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": "553834731",
    "is_description_plain_text": false,
    "is_use_direct_linking": false,
    "relationship": {
        "category": {
            "network_category_id": 18,
            "network_id": 1,
            "name": "Business",
            "status": "active",
            "time_created": 1489692867,
            "time_saved": 1526478117
        },
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "payout_revenue": {
            "total": 2,
            "entries": [
                {
                    "network_offer_payout_revenue_id": 68598,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Install",
                    "payout_type": "cpa",
                    "payout_amount": 1.6,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 2,
                    "revenue_percentage": 0,
                    "is_default": true,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609459200,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68599,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Purchase",
                    "payout_type": "cps",
                    "payout_amount": 0,
                    "payout_percentage": 5,
                    "revenue_type": "rps",
                    "revenue_amount": 0,
                    "revenue_percentage": 10,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609459200,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                }
            ]
        },
        "thumbnail_asset": {
            "network_asset_id": 1571,
            "content_type": "image/png",
            "filename": "thumbnail.png",
            "url": "https://assets.efusercontent.com/5/offers/1019/thumb/example-thumbnail.png",
            "file_size": 129863,
            "image_width": 0,
            "image_height": 0
        },
        "encoded_value": "2RJ36XN",
        "is_locked_currency": false,
        "channels": {
            "total": 1,
            "entries": [
                {
                    "network_channel_id": 5,
                    "network_id": 1,
                    "name": "Facebook",
                    "status": "active",
                    "time_created": 1583177330,
                    "time_saved": 1583177330
                }
            ]
        },
        "is_locked_caps_timezone": false,
        "meta": {
            "network_offer_id": 1019,
            "network_id": 1,
            "app_id": "553834731",
            "meta_platform": "ios",
            "advertiser_campaign_name": "",
            "bundle_id": "",
            "category": "",
            "store_url": "",
            "score_rating": 0,
            "total_rating": 0,
            "size": 0,
            "developer": "",
            "version": "",
            "is_app_unavailable": false,
            "time_created": 1609948153,
            "time_app_data_saved": 0,
            "time_saved": 1609948153
        },
        "requirement_kpis": {
            "total": 0,
            "entries": []
        },
        "requirement_tracking_parameters": {
            "total": 0,
            "entries": []
        }
    },
    "is_email_attribution_enabled": false,
    "email_attribution_method": "unknown",
    "attribution_method": "last_touch"
}

Offer Updated

The Offer Updated webhook is only fired when the offer itself is updated. For example it will be fired when :

The offer name or description is updated
Payout Revenue settings are added or modified
Caps are set on the offer
Fail traffic settings are modified on the offer

It will not, however, be fired when objects linked to the offer are modified :

Visibility is granted to the partner on the offer
The offer group which includes the offer is modified
Custom payout revenue settings for certain partners are added to the offer
New offer URLs are added / modified to the offer

The payload included in the Offer Updated webhook is the same one you would receive by making a request to the Find Offer By ID endpoint.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_offer_id": 1019,
    "network_id": 1,
    "network_advertiser_id": 64,
    "network_offer_group_id": 0,
    "name": "Updated Offer",
    "thumbnail_url": "https://assets.efusercontent.com/5/offers/1019/thumb/thumbnail.png",
    "network_category_id": 18,
    "internal_notes": "Internal Notes for the offer",
    "destination_url": "http://destination-url.com/?tid={transaction_id}",
    "server_side_url": "",
    "is_view_through_enabled": false,
    "view_through_destination_url": "",
    "preview_url": "http://preview-url.com",
    "offer_status": "active",
    "currency_id": "USD",
    "caps_timezone_id": 80,
    "project_id": "12345",
    "date_live_until": "2023-01-21",
    "html_description": "<div>Public HTML description visible to partners</div>",
    "is_using_explicit_terms_and_conditions": true,
    "terms_and_conditions": "Updated Offer T&Cs",
    "is_force_terms_and_conditions": true,
    "is_caps_enabled": true,
    "daily_conversion_cap": 200,
    "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": 50000,
    "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": true,
    "duplicate_filter_targeting_action": "block",
    "network_tracking_domain_id": 8,
    "is_use_secure_link": true,
    "is_seo_friendly": false,
    "is_allow_deep_link": false,
    "is_session_tracking_enabled": true,
    "session_tracking_start_on": "click",
    "session_tracking_lifespan_hour": 730,
    "session_tracking_minimum_lifespan_second": 60,
    "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": true,
    "redirect_routing_method": "internal",
    "redirect_internal_routing_type": "priority",
    "visibility": "require_approval",
    "time_created": 1609948152,
    "time_saved": 1609951371,
    "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": 48,
    "app_identifier": "553834731",
    "is_description_plain_text": false,
    "is_use_direct_linking": false,
    "relationship": {
        "category": {
            "network_category_id": 18,
            "network_id": 1,
            "name": "Business",
            "status": "active",
            "time_created": 1489692867,
            "time_saved": 1526478117
        },
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "payout_revenue": {
            "total": 3,
            "entries": [
                {
                    "network_offer_payout_revenue_id": 68598,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Install",
                    "payout_type": "cpa",
                    "payout_amount": 1.6,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 2,
                    "revenue_percentage": 0,
                    "is_default": true,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609948152,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68600,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Recurring Purchase",
                    "payout_type": "cpa",
                    "payout_amount": 8,
                    "payout_percentage": 0,
                    "revenue_type": "rpa",
                    "revenue_amount": 10,
                    "revenue_percentage": 0,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": false,
                    "time_created": 1609950849,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": false
                },
                {
                    "network_offer_payout_revenue_id": 68599,
                    "network_id": 1,
                    "network_offer_id": 1019,
                    "entry_name": "Purchase",
                    "payout_type": "cps",
                    "payout_amount": 0,
                    "payout_percentage": 5,
                    "revenue_type": "rps",
                    "revenue_amount": 0,
                    "revenue_percentage": 10,
                    "is_default": false,
                    "is_private": false,
                    "is_postback_disabled": false,
                    "is_enforce_caps": true,
                    "time_created": 1609948152,
                    "global_advertiser_event_id": 0,
                    "is_must_approve_conversion": false,
                    "is_allow_duplicate_conversion": true,
                    "is_email_attribution_default_event": true
                }
            ]
        },
        "thumbnail_asset": {
            "network_asset_id": 1571,
            "content_type": "image/png",
            "filename": "modifications.png",
            "url": "https://assets.efusercontent.com/1/offers/1019/thumb/thumbnail.png",
            "file_size": 129863,
            "image_width": 1313,
            "image_height": 822
        },
        "encoded_value": "2RJ36XN",
        "is_locked_currency": true,
        "channels": {
            "total": 1,
            "entries": [
                {
                    "network_channel_id": 5,
                    "network_id": 1,
                    "name": "Facebook",
                    "status": "active",
                    "time_created": 1583177330,
                    "time_saved": 1583177330
                }
            ]
        },
        "is_locked_caps_timezone": true,
        "meta": {
            "network_offer_id": 1019,
            "network_id": 1,
            "app_id": "553834731",
            "meta_platform": "ios",
            "advertiser_campaign_name": "",
            "bundle_id": "com.midasplayer.apps.candycrushsaga",
            "category": "Games",
            "store_url": "https://apps.apple.com/us/app/candy-crush-saga/id553834731?uo=4&at=10l9yE",
            "score_rating": 4.70797,
            "total_rating": 1785257,
            "size": 225218560,
            "developer": "King.com Limited",
            "version": "1.192.0.1",
            "is_app_unavailable": false,
            "time_created": 1609948153,
            "time_app_data_saved": 1609948414,
            "time_saved": 1609951371
        },
        "requirement_kpis": {
            "total": 0,
            "entries": []
        },
        "requirement_tracking_parameters": {
            "total": 0,
            "entries": []
        }
    },
    "is_email_attribution_enabled": true,
    "email_attribution_method": "last_affiliate_attribution",
    "attribution_method": "last_touch"
}

Docs: Partner Webhooks

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

Partner webhooks are fired whenever partners are created or updated.

Partner Created

This is only fired when a partner is created at a top level. Creating a new partner user for an existing partner for example will not cause this webhook to fire.

The payload included in the Partner Created webhook is the same one you would receive by making a request to the Find Affiliate By ID endpoint using both the users and billing relationships.

Note that this webhook will not fire when a partner signs up. See the “Partner Signed Up” webhook below.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_affiliate_id": 20138,
    "network_id": 1,
    "name": "Partner Name",
    "account_status": "active",
    "network_employee_id": 10,
    "internal_notes": "Internal Notes",
    "has_notifications": true,
    "network_traffic_source_id": 38,
    "account_executive_id": 39,
    "adress_id": 83932,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": false,
    "time_created": 1609459200,
    "time_saved": 1609459200,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_affiliate_user_id": 342,
                    "network_id": 1,
                    "network_affiliate_id": 20138,
                    "first_name": "Partner",
                    "last_name": "User",
                    "email": "partner-user@example.com",
                    "title": "title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609459200,
                    "time_saved": 1609459200
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "account_executive": {
            "network_employee_id": 39,
            "network_id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "full_name": "Jane Doe",
            "account_status": "inactive"
        },
        "contact_address": {
            "address_id": 83932,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 202",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "encoded_value": "25M87N33",
        "billing": {
            "network_id": 1,
            "network_affiliate_id": 20138,
            "billing_frequency": "bimonthly",
            "payment_type": "paypal",
            "invoice_amount_threshold": 100,
            "tax_id": "TAX_ID_123",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2020-07-01 00:00:00",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 10,
            "default_payment_terms": 30,
            "relationship": {
                "paypal_billing": {
                    "paypal_reception_method": "email",
                    "reception_identifier": "partner-user@example.com"
                },
                "bimonthly": {
                    "day_of_month_one": 4,
                    "day_of_month_two": 17
                }
            }
        },
        "network_affiliate_tier_id": 6,
        "ios_app_sources": {
            "total": 0,
            "entries": []
        }
    },
    "referrer_id": 36
}

Partner Updated

This is only fired when the partner itself is updated. For example it will be fired when :

The account manager of the partner is changed to a different one
The partner’s address is updated
The partner’s billing settings are modified

It will not be fired when :

Visibility is granted to the partner over a private offer
A new postback is created for the partner
A partner user is created or updated

The payload included in the Partner Updated webhook is the same one you would receive by making a request to the Find Affiliate By ID endpoint using both the users and billing relationships.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_affiliate_id": 20138,
    "network_id": 1,
    "name": "Updated Partner Name",
    "account_status": "active",
    "network_employee_id": 10,
    "internal_notes": "Internal Notes",
    "has_notifications": true,
    "network_traffic_source_id": 38,
    "account_executive_id": 39,
    "adress_id": 83932,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": false,
    "time_created": 1609459200,
    "time_saved": 1609459300,
    "relationship": {
        "labels": {
            "total": 2,
            "entries": [
                "label1",
                "label2"
            ]
        },
        "users": {
            "total": 1,
            "entries": [
                {
                    "network_affiliate_user_id": 342,
                    "network_id": 1,
                    "network_affiliate_id": 20138,
                    "first_name": "Partner",
                    "last_name": "User",
                    "email": "partner-user@example.com",
                    "title": "title",
                    "work_phone": "1234567890",
                    "cell_phone": "1234567890",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1609459200,
                    "time_saved": 1609459245
                }
            ]
        },
        "account_manager": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "account_executive": {
            "network_employee_id": 39,
            "network_id": 1,
            "first_name": "Jane",
            "last_name": "Doe",
            "full_name": "Jane Doe",
            "account_status": "inactive"
        },
        "contact_address": {
            "address_id": 83932,
            "network_id": 1,
            "address_1": "4115 Saint-Laurent",
            "address_2": "Suite 202",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2W 1Y8"
        },
        "encoded_value": "25M87N33",
        "billing": {
            "network_id": 1,
            "network_affiliate_id": 20138,
            "billing_frequency": "bimonthly",
            "payment_type": "paypal",
            "invoice_amount_threshold": 100,
            "tax_id": "TAX_ID_123",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2020-07-01 00:00:00",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 10,
            "default_payment_terms": 30,
            "relationship": {
                "paypal_billing": {
                    "paypal_reception_method": "email",
                    "reception_identifier": "partner-user@example.com"
                },
                "bimonthly": {
                    "day_of_month_one": 4,
                    "day_of_month_two": 17
                }
            }
        },
        "network_affiliate_tier_id": 6,
        "ios_app_sources": {
            "total": 0,
            "entries": []
        }
    },
    "referrer_id": 36
}

Partner Signed Up

This is only fired when the partner signs up themself using the partner signup form. Please note that if you enabled email verification for partner signups (Control Center > Configuration > General Tab > Global Settings > Enable Partner Email Verification), the webhook will only fire AFTER the email has been verified.

This webhook will not fire when the partner is created manually inside the Everflow UI.

The payload included in the Partner Signed Up webhook is the same one you would receive by making a request to the Find Affiliate By ID endpoint using the users, billing and signup relationships.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

{
    "network_affiliate_id": 20404,
    "network_id": 1,
    "name": "Example Company",
    "account_status": "pending",
    "network_employee_id": 266,
    "internal_notes": "",
    "has_notifications": true,
    "network_traffic_source_id": 0,
    "account_executive_id": 0,
    "adress_id": 84232,
    "default_currency_id": "USD",
    "is_contact_address_enabled": true,
    "enable_media_cost_tracking_links": true,
    "time_created": 1654807370,
    "time_saved": 1654807370,
    "relationship":
    {
        "labels":
        {
            "total": 0,
            "entries":
            []
        },
        "users":
        {
            "total": 1,
            "entries":
            [
                {
                    "network_affiliate_user_id": 609,
                    "network_id": 1,
                    "network_affiliate_id": 20404,
                    "first_name": "Partner",
                    "last_name": "Signup",
                    "email": "partner@example.com",
                    "title": "",
                    "work_phone": "",
                    "cell_phone": "",
                    "instant_messaging_id": 0,
                    "instant_messaging_identifier": "",
                    "language_id": 1,
                    "timezone_id": 80,
                    "currency_id": "USD",
                    "account_status": "active",
                    "time_created": 1654807370,
                    "time_saved": 1654807370
                }
            ]
        },
        "account_manager":
        {
            "first_name": "Network",
            "last_name": "Employee",
            "email": "network-employee@example.com",
            "work_phone": "",
            "cell_phone": "",
            "instant_messaging_id": 0,
            "instant_messaging_identifier": ""
        },
        "sign_up":
        {
            "network_affiliate_id": 20404,
            "network_advertiser_id": 0,
            "website_url": "facebook.com",
            "referral_code": "",
            "advertise_method": "",
            "heard_about_us": "",
            "user_ip": "24.48.56.25",
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36",
            "phone": "",
            "tax_id": "VAT Number",
            "legal_type": "unknown",
            "first_name": "Partner",
            "last_name": "Signup",
            "email": "partner@example.com",
            "time_created": 1654807275,
            "relationship":
            {
                "mailing_address":
                {
                    "address_id": 84233,
                    "network_id": 1,
                    "address_1": "7512 Chateaubriand",
                    "address_2": "",
                    "city": "Montreal",
                    "region_code": "QC",
                    "country_id": 36,
                    "country_code": "CA",
                    "zip_postal_code": "H2R 2L1"
                },
                "billing":
                {
                    "network_id": 1,
                    "network_affiliate_id": 20404,
                    "billing_frequency": "bimonthly",
                    "payment_type": "check",
                    "invoice_amount_threshold": 101,
                    "tax_id": "VAT Number",
                    "is_invoice_creation_auto": true,
                    "auto_invoice_start_date": "2022-06-09 20:41:15",
                    "default_invoice_is_hidden": false,
                    "invoice_generation_days_delay": 0,
                    "default_payment_terms": 15,
                    "is_automated_payment_enabled": false,
                    "relationship":
                    {
                        "check_billing":
                        {
                            "recipient_name": "John Doe"
                        },
                        "bimonthly":
                        {
                            "day_of_month_one": 1,
                            "day_of_month_two": 10
                        }
                    }
                },
                "promotional_information":
                [
                    {
                        "network_id": 5,
                        "network_affiliate_id": 20404,
                        "promotional_method": "affiliate",
                        "property_type": "website",
                        "property_type_url": "www.website.com",
                        "promoting_country_ids":
                        [
                            36
                        ]
                    }
                ]
            },
            "network_advertiser_full_name": ""
        },
        "contact_address":
        {
            "address_id": 84232,
            "network_id": 1,
            "address_1": "7512 Chateaubriand",
            "address_2": "",
            "city": "Montreal",
            "region_code": "QC",
            "country_id": 36,
            "country_code": "CA",
            "zip_postal_code": "H2R 2L1"
        },
        "encoded_value": "263BCH8K",
        "billing":
        {
            "network_id": 1,
            "network_affiliate_id": 20404,
            "billing_frequency": "bimonthly",
            "payment_type": "check",
            "invoice_amount_threshold": 101,
            "tax_id": "VAT Number",
            "is_invoice_creation_auto": true,
            "auto_invoice_start_date": "2022-06-09 20:41:15",
            "default_invoice_is_hidden": false,
            "invoice_generation_days_delay": 0,
            "default_payment_terms": 15,
            "is_automated_payment_enabled": false,
            "relationship":
            {
                "check_billing":
                {
                    "recipient_name": "John Doe"
                },
                "bimonthly":
                {
                    "day_of_month_one": 1,
                    "day_of_month_two": 10
                }
            }
        },
        "network_affiliate_tier_id": 28,
        "ios_app_sources":
        {
            "total": 0,
            "entries":
            []
        }
    },
    "referrer_id": 0
}

After a partner signs themselves up using the partner signup form, someone from the network must make a decision (approve or reject the partner). This webhook will fire when that decision occurs.

Note that whenever this webhook fires, the "Partner Updated" webhook documented above will also fire. This webhook is a more minimal version that only fires when that decision is made.

Payload Example

The payload of the webhook, when using the POST option will look like so :

Payload

The new_status will be : active or inactive depending on whether the partner was approved or rejected.

The network employee who made the decision is the one referenced in the payload.

{
    "network_id": 1,
    "network_affiliate_id": 37,
    "network_affiliate_name": "John Doe",
    "new_status": "inactive",
    "employee_id": 1,
    "employee_full_name": "Peter Johnson",
    "timestamp": 1718918402
}

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: Conversion Tracking

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

Conversions can also be tracked using the Everflow SDK using the following code :

EF.conversion({
  offer_id: 1, // The offer id. Required if aid is not provided
  aid: 2, // The advertiser id. Required if offer_id is not provided
  transaction_id: '', // Optional. The Everflow unique transaction id
})

While the transaction_id is optional, providing it is always more reliable if you have access to it. When the value is missing, the SDK tries to locate it using :

First Party Cookie
Third Party Cookie (on the tracking domain)

Additional options may be used on the EF.conversion method :

EF.conversion({
  offer_id: 1, // The offer id. Required if aid is not provided
  aid: 2, // The advertiser id. Required if offer_id is not provided
  transaction_id: '', // Optional. The Everflow unique transaction id

  amount: 0, // Optional. Sale Amount -- relevant for RPS offers

  event_id: 0, // Optional. The event id
  coupon_code: '', // Optional. Coupon code

  adv_event_id: 0, // Optional. If you use global advertiser events

  order_id: '', // Optional
  user_id: '', // Optional. User tracking

  verification_token: '', // Required if the advertiser is configured to use verification tokens
  email: '', // Optional

  // Optional. Adv placement values.
  adv1: '',
  adv2: '',
  adv3: '',
  adv4: '',
  adv5: '',
})

Custom Parameters

It’s also possible to add free form parameters to the conversion. This is effectively equivalent to adding additional query string parameters when using server postbacks.

EF.conversion({
  offer_id: 1, // The offer id. Required if aid is not provided
  aid: 2, // The advertiser id. Required if offer_id is not provided
  transaction_id: 'af189e77650e4e908af797b61b03ac0b', // Optional. The Everflow unique transaction id
  amount: 19.99, // Optional. Sale Amount -- relevant for RPS offers
  event_id: 23, // Optional. The event id

  //Optional. Free form parameters to be appended to the conversion URL
  parameters: {
    "param1" : "customValue1",
    "param2" : "customValue2" 
  }
})

Advanced Use

Fetching The Transaction ID / Conversion ID

The EF.conversion method returns a Promise which, when resolved, will give you an object that contains both the transaction ID and the conversion ID related to the conversion that was just generated.

EF.conversion({
  offer_id: 1, 
  aid: 2, 
  amount: 9.99, 
  event_id: 11,
})
.then((conversion) => {
  console.log(conversion.conversion_id);
  console.log(conversion.transaction_id)
});

Docs: Dashboard Stats

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

Dashboard Summary

POST /v1/affiliates/dashboard/summary

This endpoint is used to generate the cards at the top of the Everflow dashboard page in the UI. It lists comparative data for standard reporting metrics such as payout, revenue, number of clicks, etc. over time.

For every metric, values for current month vs total of last month and today vs total of yesterday are listed.

Performance values are computed by comparing yesterday value at the same moment of the day as now.

The endpoint takes a single parameter in the request body : a timezone id. Find all timezones here

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/affiliates/dashboard/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "timezone_id": 80
  }'

Response

{
    "revenue": {
        "today": 4,
        "yesterday": 5.6,
        "current_month": 23.20,
        "last_month": 0,
        "trending_percentage": -28.6
    },
    "click": {
        "today": 46,
        "yesterday": 9,
        "current_month": 74,
        "last_month": 0,
        "trending_percentage": 411.1
    },
    "conversion": {
        "today": 5,
        "yesterday": 7,
        "current_month": 29,
        "last_month": 0,
        "trending_percentage": -28.6
    },
    "cvr": {
        "today": 10.87,
        "yesterday": 77.778,
        "current_month": 39.189,
        "last_month": 0
    },
    "events": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "evr": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "redirect_revenue": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "impression": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    }
}

Docs: Dashboard Stats

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

Dashboard Summary

For every metric, values for current month vs total of last month and today vs total of yesterday are listed.

Performance values are computed by comparing yesterday value at the same moment of the day as now.

GET /v1/networks/dashboard/summary

Request Example

cURL

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

Response

{
    "revenue":
    {
        "today": 28576.65,
        "yesterday": 41199.12,
        "current_month": 270315.70,
        "last_month": 929350.99,
        "trending_percentage": -23.4
    },
    "payout":
    {
        "today": 8060.50,
        "yesterday": 9692.5664,
        "current_month": 76260.50,
        "last_month": 258850.17,
        "trending_percentage": -5.7
    },
    "profit":
    {
        "today": 20516.15,
        "yesterday": 31506.55,
        "current_month": 194055.19,
        "last_month": 670500.82,
        "trending_percentage": -28.6
    },
    "margin":
    {
        "today": 71.793,
        "yesterday": 76.474,
        "current_month": 71.788,
        "last_month": 72.147
    },
    "click":
    {
        "today": 84386,
        "yesterday": 112299,
        "current_month": 780852,
        "last_month": 3089428,
        "trending_percentage": -16.9
    },
    "conversion":
    {
        "today": 1188,
        "yesterday": 1320,
        "current_month": 10674,
        "last_month": 36741,
        "trending_percentage": 1.7
    },
    "event":
    {
        "today": 619,
        "yesterday": 837,
        "current_month": 5887,
        "last_month": 20056,
        "trending_percentage": -17.6
    },
    "cvr":
    {
        "today": 1.408,
        "yesterday": 1.175,
        "current_month": 1.367,
        "last_month": 1.189
    },
    "evr":
    {
        "today": 52.104,
        "yesterday": 63.409,
        "current_month": 55.153,
        "last_month": 54.588
    },
    "cpc":
    {
        "today": 0.096,
        "yesterday": 0.086,
        "current_month": 0.098,
        "last_month": 0.084
    },
    "epc":
    {
        "today": 0.243,
        "yesterday": 0.281,
        "current_month": 0.249,
        "last_month": 0.217
    },
    "rpc":
    {
        "today": 0.339,
        "yesterday": 0.367,
        "current_month": 0.346,
        "last_month": 0.301
    },
    "rpm":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "cpm":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "gross_sales":
    {
        "today": 87996,
        "yesterday": 106358,
        "current_month": 814262,
        "last_month": 2819896,
        "trending_percentage": -6.9
    },
    "gross_click":
    {
        "today": 136836,
        "yesterday": 158173,
        "current_month": 1245805,
        "last_month": 4900458,
        "trending_percentage": -2.4
    },
    "impression":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "ctr":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "invalid_click":
    {
        "today": 52450,
        "yesterday": 45874,
        "current_month": 464953,
        "last_month": 1811030,
        "trending_percentage": 35.4
    },
    "duplicate_click":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 20,
        "last_month": 63,
        "trending_percentage": 0
    },
    "unique_click":
    {
        "today": 84386,
        "yesterday": 112299,
        "current_month": 780832,
        "last_month": 3089365,
        "trending_percentage": -16.9
    },
    "view_through_conversion":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "approved_conversion":
    {
        "today": 1166,
        "yesterday": 1304,
        "current_month": 10510,
        "last_month": 36156,
        "trending_percentage": 1
    },
    "throttled_conversion":
    {
        "today": 22,
        "yesterday": 16,
        "current_month": 164,
        "last_month": 585,
        "trending_percentage": 57.1
    }
}

Docs: Rate Limiting

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

The Everflow API is subject to per entity rate limits

Quotas

Our system enforces rate limits according to the user type interacting with our services, and these limits are shared among all users within the same organization. For example, both Publisher A and Publisher B would be allocated 5 queries per second when accessing the API for the same Everflow client.

User	Queries per second
Network	20
Affiliate	5
Advertiser	5
Partner	5

Rate Limiting

Rate limiting resets every 30 seconds. Every request contains the following headers:

Header	Purpose
X-RateLimit-Limit	The number of requests you can make each 30 seconds
X-RateLimit-Remaining	The number of requests you can still make for the current 30 seconds window

Once you reach your limit, requests will all return a 429 error code until your 30 seconds window resets.

Concurrent Requests

On top of the rate limits, the number of concurrent requests is capped on reporting endpoints.

There can only be up to 10 concurrent requests made to the /v1/networks/reporting/* endpoints. Subsequence concurrent requests will return an error.

Granular Reports (BigQuery) Quotas

Most of the reporting endpoints in Everflow gets data in MySQL, but some data are only available in BigQuery. Calls using BigQuery are limited by hour. Please note that the Affiliate and Advertiser quotas is applicable to all activities at the network level, not per affiliate / advertiser.

User	Queries per hour
Network	1000
Affiliate	1000
Advertiser	1000

Important : The number of queries is rate limited per period of 60 minutes but doesn’t necessarily match the start and end of the hour. Rate limiting will kick in whenever the number of requests exceeds the limit over any rolling period of 60 minutes.

If a call contains at least one of the following columns, it is made in BigQuery.

Geolocation:

Country, Region, City, DMA, Carrier, ISP, Connection Type, Postal Code, Is Proxy

Device:

Platform, OS Version, Device Type, Browser, Device Brand, Language, Device Model, Device Make

Offer :

Offer Group, Offer URL, Event name, Advertiser Event Name, Payout Type, Payout Amount, Revenue Type, Revenue Amount, Custom Payout Revenue

Misc:

Adv1, Avd2, Adv3, Adv4, Adv5, Sub1, Sub2, Sub3, Sub4, Sub5, Source ID, Project ID, Referrer, Coupon Code, Tracking Domain, Order ID, Attribution Method, Account Referred By

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: Errors

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

All responses are returned in JSON format as specified in the Content-Type header.

Conventional HTTP response codes are used by the API to indicate the success or failure of an API request. Codes in the 2xx range indicate success whereas codes in the 4xx or 5xx range indicate failure.

Common Error Codes

Code	Description
400	Bad Request : The request could not be handled correctly, usually because of missing or malformed parameters
401	Unauthorized / No Authentication Method Found : The request could not be accepted, can be because the API Key is missing from the request
403	Forbidden / Out Of Realm : An API key was used, but it doesn’t allow access to the resource requested. Can be because the wrong API is being used (e.g. an Affiliate API key used on a Network API endpoint)
404	Not Found : The resource could not be found
429	Too Many Requests : The request could not be served as the API rate limiting restriction was enforced
500	Internal Server Error : Something went wrong on the Everflow end

Docs: Everflow's Marketplace API Model

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

Partners who participate in the Marketplace on Everflow establish connections with one or multiple brands. Data fetched from the Marketplace API will include relevant information from all the brands with which a connection was established.

For example, when fetching offers from the Marketplace API while being connected to 3 different brands you can expect the following :

Top level model of the Everflow Marketplace API

Everflow, however, is a software provider and does not act like a network. Consequently, each brand actually "owns" their own instance of Everflow from which data is exposed through the Affiliate API.

When Marketplace partners create a connection with a brand in Everflow, they also gain access to the brand's affiliate API which exposes all the data available in the Everflow UI.

The Marketplace API serves as an umbrella over the different brand connections and allows API users to fetch data from all brands in a single call.

Inner workings of the Everflow Marketplace API

In other words, using the Marketplace API is actually optional, since API users are free to access the Affiliate API directly :

Direct connection with a brand's Affiliate API

And since there is no aggregation layer between the Affiliate API and the API user, there are scenarios in which it can be beneficial to access the Affiliate API directly. For example, more filters will be offered on reporting and offer endpoints.

Because Everflow works with a one-instance-per-brand model, power users of the API should explore this way of working, which essentially involves 2 steps :

Fetch the API key associated with each brand the partner is connected with through this endpoint
Use the Affiliate API to accomplish the required task

Direct connection with a brand's Affiliate API

Docs: Impression Tracking

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

The simplest way to start tracking impressions is to generate an impression using the following code :

EF.impression({
  offer_id: 1, // Required. The offer id
  affiliate_id: 1, //Required. The affiliate id
});

You may wish to add additional data that will be passed along with the impression :

EF.impression({
  offer_id: 1, // Required. The offer id
  affiliate_id: 1, //Required. The affiliate id

  // Optional. Sub placement values.
  sub1: '',
  sub2: '',
  sub3: '',
  sub4: '',
  sub5: '',
  source_id: '',

  fbclid: '...', // Facebook unique click ID
  gclid: '...', // Google unique click ID
});

Extracting data from the URL

When working with direct linking, the affiliate id involved in the impression will most likely be dynamic and the value will be passed in the query string of the URL.

EF.impression({
  offer_id: 1, // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id
});

EF.impression({
  offer_id: EF.urlParameter('oid'), // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id
  
  sub3: EF.urlParameter('src'), // Optional : "facebook" would be passed as the sub3 in this example
  sub4: EF.urlParameter('app'), // Optional : "mobile" would be passed as the sub4 in this example
  sub5: EF.urlParameter('ref'), // The "ref" query string parameter is missing from the URL. Nothing would be passed as the sub5

});

Custom Parameters

It’s also possible to add free form parameters to the impression. This is effectively equivalent to adding additional query string parameters to the tracking link URL.

EF.impression({
  offer_id: EF.urlParameter('oid'), // Required. The offer id
  affiliate_id: EF.urlParameter('affid'), //Required. The affiliate id

  //Optional. Free form parameters to be appended to the impression URL
  parameters: {
    "param1" : "customValue1",
    "param2" : "customValue2" 
  }
})

Multiple Everflow Accounts

In a typical scenario where a single Everflow account generates an impression on a page, there is no need to “identify” the account responsible for the impression. The information is inferred from the <script> tag used to include the Everflow SDK. For example :

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN-A.com/scripts/main.js"></script>
<script>
  // This click will be attributed to the account that owns "www.TRACKING-DOMAIN-A.com"
  EF.impression({
    offer_id: 1,
    affiliate_id: 1
  });
</script>

Situations may come up where multiple Everflow customers wish to generate impressions on the same page (multi-tenant scenarios). The EF.impression function takes an optional tracking_domain parameter that can be used to associate impressions with specific accounts, regardless of the account that originally imported the script on the page.

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN-A.com/scripts/main.js"></script>
<script>
  // This impression will be attributed to the account that owns "www.TRACKING-DOMAIN-A.com"
  EF.impression({
    tracking_domain: "www.TRACKING-DOMAIN-A.com",
    offer_id: 1,
    affiliate_id: 1
  });

  // This impression will be attributed to the account that owns "www.TRACKING-DOMAIN-B.com"
  EF.impression({
    tracking_domain: "www.TRACKING-DOMAIN-B.com",
    offer_id: 50,
    affiliate_id: 17
  });
</script>

More information about multi-tenant scenarios can be found on the Click Tracking page.

Docs: Raw Clicks Report

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

In the endpoints documented here, each click is a “row” in the response. The data is not aggregated.

Important: While the clicks analytics are kept forever, the raw data used to create the response on these endpoints is only kept for a period of 3 months on the Everflow servers. Requests for time intervals that go beyond that period will not return clicks. Raw data for clicks that lead to conversions, however, is kept forever.

Click Report

POST /v1/affiliates/reporting/clicks/stream

This endpoint is used to extract a raw list of clicks. In the result of this request, each click will be one element / row. To avoid extremely slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of clicks that can be returned by this endpoint is : 5000. If there are more than 5000 clicks that match the request, they will not be returned.

Requests are only allowed for a period of 14 days of less. Requesting a longer period will result in an error (400 bad request).

This endpoint should not be used to extract every click from the platform.

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
        "filter_id_value": "883",
        "resource_type": "offer"
      },
      {
        "filter_id_value": "518",
        "resource_type": "offer"
      },
      {
        "filter_id_value": "United States",
        "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, creative, country, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, s1, s2, s3, s4, s5, coupon_code

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/affiliates/reporting/clicks/stream \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Include only clicks that comes from the US or Canada and that have the "internal" value passed as a sub1.

{
  "from": "2022-02-08 16:30:00",
  "to": "2022-02-08 16:45:00",
  "timezone_id": 90,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "internal",
        "resource_type": "s1"
      },
      {
        "filter_id_value": "Canada",
        "resource_type": "country"
      },
      {
        "filter_id_value": "United States",
        "resource_type": "country"
      }
    ]
  }
}

Example 2 : All clicks on 2 offers

{
  "from": "2022-02-01 12:30:00",
  "to": "2022-02-01 13:00:00",
  "timezone_id": 90,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "882",
        "resource_type": "offer"
      },
      {
        "filter_id_value": "883",
        "resource_type": "offer"
      }
    ]
  }
}

Example 3 : Clicks that have a sub3 value of "test"

{
  "from": "2022-02-01 12:30:00",
  "to": "2022-02-01 13:00:00",
  "timezone_id": 90,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "test",
        "resource_type": "s3"
      }
    ]
  }
}

Response

{
  "clicks": [
    {
      "transaction_id": "410da86457f54ae388a871d54a33275b",
      "is_unique": 1,
      "unix_timestamp": 1702313995,
      "tracking_url": "www.tracking-link.com",
      "source_id": "",
      "sub1": "facebook",
      "sub2": "",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "revenue_type": "CPA",
      "revenue": 0,
      "referer": "",
      "error_code": 0,
      "user_ip": "127.0.0.1",
      "error_message": "N/A",
      "idfa": "",
      "idfa_md5": "",
      "idfa_sha1": "",
      "google_ad_id": "",
      "google_ad_id_md5": "",
      "google_ad_id_sha1": "",
      "android_id": "",
      "android_id_md5": "",
      "android_id_sha1": "",
      "currency_id": "USD",
      "coupon_code": "SUMMER",
      "relationship": {
        "offer": {
          "network_offer_id": 1,
          "network_id": 1,
          "name": "Example Offer",
          "offer_status": "active",
          "network_tracking_domain_id": 1
        },
        "geolocation": {
          "country_code": "US",
          "country_name": "United States",
          "region_code": "",
          "region_name": "California",
          "city_name": "Burbank",
          "dma": 803,
          "dma_name": "Los Angeles, CA",
          "timezone": "America/Los_Angeles",
          "carrier_name": "T-Mobile USA",
          "carrier_code": 0,
          "organization": "",
          "isp_name": "T-mobile Usa Inc.",
          "is_mobile": false,
          "is_proxy": false,
          "postal_code": ""
        },
        "device_information": {
          "is_mobile": true,
          "platform_name": "macOS",
          "os_version": "",
          "brand": "Apple",
          "model": "",
          "is_tablet": false,
          "browser_name": "Safari",
          "browser_version": "",
          "device_type": "PC",
          "language": "fr",
          "http_accept_language": "",
          "is_robot": false,
          "is_filter": false
        },
        "query_parameters": {
          "__cc": "SUMMER"
        }
      }
    }
  ]
}

Click By ID

GET /v1/affiliates/reporting/clicks/:transactionId

Fetch a single click by its unique Everflow transaction ID.

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/affiliates/reporting/clicks/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "transaction_id": "d746e9ab66914764b6a0cf6ab25d0cdf",
  "is_unique": 1,
  "unix_timestamp": 1661970238,
  "tracking_url": "www.tracking-domain.test",
  "source_id": "",
  "sub1": "internal",
  "sub2": "",
  "sub3": "facebook",
  "sub4": "",
  "sub5": "",
  "revenue_type": "CPA",
  "revenue": 0,
  "referer": "",
  "error_code": 0,
  "user_ip": "68.26.161.189",
  "error_message": "N/A",
  "idfa": "",
  "idfa_md5": "",
  "idfa_sha1": "",
  "google_ad_id": "",
  "google_ad_id_md5": "",
  "google_ad_id_sha1": "",
  "android_id": "",
  "android_id_md5": "",
  "android_id_sha1": "",
  "currency_id": "USD",
  "coupon_code": "SUMMER",
  "relationship": {
    "offer": {
      "network_offer_id": 3,
      "network_id": 1,
      "name": "Example Offer Name",
      "offer_status": "active",
      "network_tracking_domain_id": 1
    },
    "geolocation": {
      "country_code": "US",
      "country_name": "United States",
      "region_code": "",
      "region_name": "California",
      "city_name": "Burbank",
      "dma": 803,
      "dma_name": "Los Angeles, CA",
      "timezone": "America/Los_Angeles",
      "carrier_name": "T-Mobile USA",
      "carrier_code": 0,
      "organization": "",
      "isp_name": "T-mobile Usa Inc.",
      "is_mobile": false,
      "is_proxy": false,
      "postal_code": ""
    },
    "device_information": {
      "is_mobile": true,
      "platform_name": "macOS",
      "os_version": "",
      "brand": "Apple",
      "model": "",
      "is_tablet": false,
      "browser_name": "Safari",
      "browser_version": "",
      "device_type": "PC",
      "language": "fr",
      "http_accept_language": "",
      "is_robot": false,
      "is_filter": false
    },
    "query_parameters": {
      "__cc": "SUMMER"
    }
  }
}

Docs: Raw Clicks Report

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

In the endpoints documented here, each click is a “row” in the response. The data is not aggregated.

Are you looking to fetch all your clicks? If so, the Firehose might be suited for your use case.

Click Report

POST /v1/networks/reporting/clicks/stream

The maximum number of clicks that can be returned by this endpoint is : 10 000. If there are more than 10 000 clicks that match the request, they will not be returned.

Requests are only allowed for a period of 14 days of less. Requesting a longer period will result in an error (400 bad request).

This endpoint should not be used to extract every click from the platform. Requests to extracts large lists of clicks should be made via the Request Report feature.

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, account_manager, affiliate_manager, category, billing_frequency, country, region, city, dma, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, isp, offer_status, s1, s2, s3, s4, s5, channel, coupon_code, affiliate_tier

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/clicks/stream \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Include only clicks that comes from the US or Canada and that have the "internal" value passed as a sub1.

{
    "from": "2022-02-08 16:30:00",
	"to": "2022-02-08 16:45:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "internal",
                "resource_type": "s1"
            },
            {
                "filter_id_value": "Canada",
                "resource_type": "country"
            },
            {
                "filter_id_value": "United States",
                "resource_type": "country"
            }
        ]
    }
}

Example 2 : Clicks for all partners on 2 offers

{
    "from": "2022-02-01 12:30:00",
	"to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Clicks that have a sub3 value of "test"

{
    "from": "2022-02-01 12:30:00",
    "to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "test",
                "resource_type": "s3"
            }
        ]
    }
}

Response

{
    "clicks":
    [
		{
		    "transaction_id": "b35dc35c6c804a808782dbecd1e59b04",
		    "is_unique": 1,
		    "unix_timestamp": 1605194171,
		    "tracking_url": "www.tracking-domain.test",
		    "source_id": "",
		    "sub1": "internal",
		    "sub2": "",
		    "sub3": "facebook",
		    "sub4": "",
		    "sub5": "",
		    "payout_type": "CPA",
		    "revenue_type": "RPA",
		    "payout": 0,
		    "revenue": 0,
		    "referer": "",
		    "previous_network_offer_id": 0,
		    "error_code": 0,
		    "project_id": "",
		    "user_ip": "35.35.1.89",
		    "error_message": "N/A",
		    "url": "",
		    "is_view_through": false,
		    "is_async": false,
		    "server_side_url": "",
		    "server_side_output": "",
		    "custom_landing_page_id": 0,
		    "is_test_mode": false,
		    "idfa": "",
		    "idfa_md5": "",
		    "idfa_sha1": "",
		    "google_ad_id": "",
		    "google_ad_id_md5": "",
		    "google_ad_id_sha1": "",
		    "android_id": "",
		    "android_id_md5": "",
		    "android_id_sha1": "",
		    "error_filter_id": "",
		    "has_conversion": true,
		    "is_pass_through": false,
		    "creative_id": 0,
		    "relationship": {
		        "offer": {
		            "network_offer_id": 1,
		            "network_id": 1,
		            "network_advertiser_id": 13,
		            "network_offer_group_id": 1,
		            "name": "Example Offer",
		            "offer_status": "active",
		            "network_tracking_domain_id": 1,
		            "visibility": "public",
		            "currency_id": "USD"
		        },
		        "advertiser": {
		            "network_advertiser_id": 13,
		            "network_id": 1,
		            "name": "Example Advertiser Inc.",
		            "account_status": "active"
		        },
		        "account_manager": {
		            "network_employee_id": 2,
		            "network_id": 1,
		            "first_name": "Bob",
		            "last_name": "Smith",
		            "full_name": "Bob Smith",
		            "account_status": "active"
		        },
		        "affiliate": {
		            "network_affiliate_id": 7,
		            "network_id": 1,
		            "name": "Example Partner Inc.",
		            "account_status": "active",
		            "network_traffic_source_id": 0
		        },
		        "affiliate_manager": {
		            "network_employee_id": 2,
		            "network_id": 1,
		            "first_name": "Bob",
		            "last_name": "Smith",
		            "full_name": "Bob Smith",
		            "account_status": "active"
		        },
		        "offer_group": {
		            "network_offer_group_id": 1,
		            "network_id": 1,
		            "network_advertiser_id": 13,
		            "name": "Example Offer Group",
		            "offer_group_status": "active",
		            "offer_count": 0
		        },
		        "geolocation":
		        {
		            "country_code": "JP",
		            "country_name": "Japan",
		            "region_code": "",
		            "region_name": "Gunma",
		            "city_name": "Minakami",
		            "dma": 0,
		            "dma_name": "",
		            "timezone": "Asia/Tokyo",
		            "carrier_name": "",
		            "carrier_code": 0,
		            "organization": "",
		            "isp_name": "Japan Nation-wide Network Of Softbank Corp.",
		            "is_mobile": false,
		            "is_proxy": false,
		            "postal_code": ""
		        },
		        "device_information": {
		            "is_mobile": false,
		            "platform_name": "macOS",
		            "os_version": "10.15",
		            "brand": "Apple",
		            "model": "Macintosh",
		            "is_tablet": false,
		            "browser_name": "Chrome",
		            "browser_version": "86",
		            "device_type": "PC",
		            "language": "en",
		            "http_accept_language": "en-US,en;q=0.9,fr;q=0.8",
		            "is_robot": false,
		            "is_filter": false
		        },
		        "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36",
		        "http_accept_language": "en-US,en;q=0.9,fr;q=0.8",
		        "query_parameters": {},
		        "redirect_url": "http://example.com/test.php?aid=7&oid=1&tid=b35dc35c6c804a808782dbecd1e59b04",
		        "forensiq_score": "0"
		    },
		    "coupon_code": "",
		    "redirect_method": "standard",
		    "is_sdk_click": false,
		    "category_id": 1,
		    "currency_id": "USD"
		}
    ]
}

Click By ID

GET /v1/networks/reporting/clicks/:transactionId

Fetch a single click by its unique Everflow transaction ID.

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/clicks/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "transaction_id": "b35dc35c6c804a808782dbecd1e59b04", "is_unique": 1, "unix_timestamp": 1605194171, "tracking_url": "www.tracking-domain.test", "source_id": "", "sub1": "internal", "sub2": "", "sub3": "facebook", "sub4": "", "sub5": "", "payout_type": "CPA", "revenue_type": "RPA", "payout": 0, "revenue": 0, "referer": "", "previous_network_offer_id": 0, "error_code": 0, "project_id": "", "user_ip": "35.35.1.89", "error_message": "N/A", "url": "", "is_view_through": false, "is_async": false, "server_side_url": "", "server_side_output": "", "custom_landing_page_id": 0, "is_test_mode": false, "idfa": "", "idfa_md5": "", "idfa_sha1": "", "google_ad_id": "", "google_ad_id_md5": "", "google_ad_id_sha1": "", "android_id": "", "android_id_md5": "", "android_id_sha1": "", "error_filter_id": "", "has_conversion": true, "is_pass_through": false, "creative_id": 0, "relationship": { "offer": { "network_offer_id": 1, "network_id": 1, "network_advertiser_id": 13, "network_offer_group_id": 1, "name": "Example Offer", "offer_status": "active", "network_tracking_domain_id": 1, "visibility": "public", "currency_id": "USD" }, "advertiser": { "network_advertiser_id": 13, "network_id": 1, "name": "Example Advertiser Inc.", "account_status": "active" }, "account_manager": { "network_employee_id": 2, "network_id": 1, "first_name": "Bob", "last_name": "Smith", "full_name": "Bob Smith", "account_status": "active" }, "affiliate": { "network_affiliate_id": 7, "network_id": 1, "name": "Example Partner Inc.", "account_status": "active", "network_traffic_source_id": 0 }, "affiliate_manager": { "network_employee_id": 2, "network_id": 1, "first_name": "Bob", "last_name": "Smith", "full_name": "Bob Smith", "account_status": "active" }, "offer_group": { "network_offer_group_id": 1, "network_id": 1, "network_advertiser_id": 13, "name": "Example Offer Group", "offer_group_status": "active", "offer_count": 0 }, "geolocation": { "country_code": "JP", "country_name": "Japan", "region_code": "", "region_name": "Gunma", "city_name": "Minakami", "dma": 0, "dma_name": "", "timezone": "Asia/Tokyo", "carrier_name": "", "carrier_code": 0, "organization": "", "isp_name": "Japan Nation-wide Network Of Softbank Corp.", "is_mobile": false, "is_proxy": false, "postal_code": "" }, "device_information": { "is_mobile": false, "platform_name": "macOS", "os_version": "10.15", "brand": "Apple", "model": "Macintosh", "is_tablet": false, "browser_name": "Chrome", "browser_version": "86", "device_type": "PC", "language": "en", "http_accept_language": "en-US,en;q=0.9,fr;q=0.8", "is_robot": false, "is_filter": false }, "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36", "http_accept_language": "en-US,en;q=0.9,fr;q=0.8", "query_parameters": {}, "redirect_url": "http://example.com/test.php?aid=7&oid=1&tid=b35dc35c6c804a808782dbecd1e59b04", "forensiq_score": "0" }, "coupon_code": "", "redirect_method": "standard", "is_sdk_click": false, "category_id": 1, "currency_id": "USD" }

Flowchart / Transactions

GET /v1/networks/reporting/transactions/:transactionId

This endpoint can be used to retrieve the information from the flowchart in the Everflow UI. While the concept of a flowchart doesn’t make much sense in the context of an API, it can still be useful to get an overview of all the “events” (clicks, conversions, partner postbacks) related to a given transaction ID.

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/transactions/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "click":
    {
        "transaction_id": "93680ac61eb047fab77347734520967f",
        "is_unique": 1,
        "unix_timestamp": 1625058552,
        "tracking_url": "www.tracking-domain.com",
        "source_id": "",
        "sub1": "s1",
        "sub2": "",
        "sub3": "facebook",
        "sub4": "",
        "sub5": "app_store",
        "payout_type": "CPA",
        "revenue_type": "RPA",
        "payout": 0,
        "revenue": 0,
        "referer": "",
        "previous_network_offer_id": 0,
        "error_code": 0,
        "project_id": "",
        "user_ip": "74.14.245.141",
        "error_message": "N/A",
        "url": "",
        "is_view_through": false,
        "is_async": false,
        "server_side_url": "",
        "server_side_output": "",
        "custom_landing_page_id": 0,
        "is_test_mode": false,
        "idfa": "",
        "idfa_md5": "",
        "idfa_sha1": "",
        "google_ad_id": "",
        "google_ad_id_md5": "",
        "google_ad_id_sha1": "",
        "android_id": "",
        "android_id_md5": "",
        "android_id_sha1": "",
        "error_filter_id": "",
        "has_conversion": true,
        "is_pass_through": false,
        "creative_id": 0,
        "relationship":
        {
            "offer":
            {
                "network_offer_id": 5,
                "network_id": 1,
                "network_advertiser_id": 13,
                "network_offer_group_id": 0,
                "name": "CPA Offer",
                "offer_status": "active",
                "network_tracking_domain_id": 1,
                "visibility": "require_approval",
                "currency_id": "USD"
            },
            "advertiser":
            {
                "network_advertiser_id": 13,
                "network_id": 1,
                "name": "Ads for Everyone",
                "account_status": "active"
            },
            "account_manager":
            {
                "network_employee_id": 1,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "affiliate":
            {
                "network_affiliate_id": 113,
                "network_id": 1,
                "name": "Digital Supply",
                "account_status": "active",
                "network_traffic_source_id": 0
            },
            "affiliate_manager":
            {
                "network_employee_id": 1,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "geolocation":
            {
                "country_code": "CA",
                "country_name": "Canada",
                "region_code": "QC",
                "region_name": "Quebec",
                "city_name": "Greenfield Park",
                "dma": 0,
                "dma_name": "",
                "timezone": "America/Montreal",
                "carrier_name": "",
                "carrier_code": 0,
                "organization": "Bell Canada",
                "isp_name": "bell canada",
                "is_mobile": false,
                "is_proxy": false,
                "postal_code": "j4v 2v7"
            },
            "device_information":
            {
                "is_mobile": false,
                "platform_name": "macOS",
                "os_version": "10.15",
                "brand": "Apple",
                "model": "Macintosh",
                "is_tablet": false,
                "browser_name": "Chrome",
                "browser_version": "91",
                "device_type": "PC",
                "language": "en",
                "http_accept_language": "en-US,en;q=0.9",
                "is_robot": false,
                "is_filter": false
            },
            "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
            "http_accept_language": "en-US,en;q=0.9",
            "query_parameters":
            {},
            "redirect_url": "https://landing-page.com",
            "forensiq_score": "0"
        },
        "coupon_code": "",
        "redirect_method": "standard",
        "is_sdk_click": false
    },
    "conversions":
    {
        "total": 1,
        "entries":
        [
            {
                "conversion_id": "d51bc674770f40b68a08f8f65fa2a344",
                "conversion_unix_timestamp": 1625058585,
                "sub1": "",
                "sub2": "",
                "sub3": "",
                "sub4": "",
                "sub5": "",
                "source_id": "",
                "status": "approved",
                "payout_type": "cpa",
                "revenue_type": "rpa",
                "payout": 3.5,
                "revenue": 7,
                "session_user_ip": "74.14.245.141",
                "conversion_user_ip": "74.14.245.141",
                "country": "Canada",
                "region": "Quebec",
                "city": "Greenfield Park",
                "dma": 0,
                "carrier": "",
                "platform": "macOS",
                "os_version": "10.15",
                "device_type": "PC",
                "device_model": "",
                "brand": "Apple",
                "browser": "Chrome",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
                "adv1": "",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "is_event": false,
                "event": "",
                "notes": "",
                "transaction_id": "93680ac61eb047fab77347734520967f",
                "click_unix_timestamp": 1625058552,
                "error_code": 0,
                "error_message": "N/A",
                "sale_amount": 0,
                "is_scrub": false,
                "coupon_code": "",
                "order_id": "",
                "url": "",
                "isp": "bell canada",
                "referer": "",
                "app_id": "",
                "idfa": "",
                "idfa_md5": "",
                "idfa_sha1": "",
                "google_ad_id": "",
                "google_ad_id_md5": "",
                "google_ad_id_sha1": "",
                "android_id": "",
                "android_id_md5": "",
                "android_id_sha1": "",
                "currency_id": "USD",
                "email": "",
                "is_view_through": false,
                "previous_network_offer_id": 0,
                "relationship":
                {
                    "offer":
                    {
                        "network_offer_id": 5,
                        "network_id": 1,
                        "network_advertiser_id": 13,
                        "network_offer_group_id": 0,
                        "name": "CPA Offer",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1,
                        "visibility": "require_approval",
                        "currency_id": "USD"
                    },
                    "advertiser":
                    {
                        "network_advertiser_id": 13,
                        "network_id": 1,
                        "name": "Ads for Everyone",
                        "account_status": "active"
                    },
                    "account_manager":
                    {
                        "network_employee_id": 1,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "affiliate":
                    {
                        "network_affiliate_id": 113,
                        "network_id": 1,
                        "name": "Digital Supply",
                        "account_status": "active",
                        "network_traffic_source_id": 0
                    },
                    "affiliate_manager":
                    {
                        "network_employee_id": 1,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "query_parameters": {},
                    "attribution_method": "transaction_id",
                    "usm_data": null
                },
                "network_offer_payout_revenue_id": 0
            }
        ]
    },
    "pixels":
    {
        "total": 1,
        "entries":
        [
            {
                "network_id": 1,
                "network_offer_id": 5,
                "network_offer_payout_revenue_id": 0,
                "affiliate_id": 114,
                "pixel_id": 329,
                "conversion_id": "d51bc674770f40b68a08f8f65fa2a344",
                "transaction_id": "93680ac61eb047fab77347734520967f",
                "timestamp": 1625058585,
                "delivery_method": "postback",
                "pixel_level": "global",
                "pixel_status": "active",
                "pixel_type": "conversion",
                "payload": "http://partner-pixel.io/?tid=93680ac61eb047fab77347734520967f",
                "is_success": true,
                "debug_information": "PostbackUrl: http://partner-pixel.io/?tid=93680ac61eb047fab77347734520967f\nStatus: 200\nScheme: \nPath: \nAuthority: \nHeaders: Keep-Alive: [timeout=5, max=100],Server: [Apache/2.4.10 (Debian)],Connection: [Keep-Alive],Content-Length: [61],Date: [Wed, 30 Jun 2021 13:09:45 GMT],Content-Type: [text/html; charset=UTF-8]\nReturn: <pre>Array\n(\n    [tid] => 93680ac61eb047fab77347734520967f\n)\n\n",
                "last_attempt": 0,
                "failed_attempts": 0,
                "relationship":
                {
                    "offer":
                    {
                        "network_offer_id": 5,
                        "network_id": 1,
                        "network_advertiser_id": 13,
                        "network_offer_group_id": 0,
                        "name": "CPA Offer",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1,
                        "visibility": "require_approval",
                        "currency_id": "USD"
                    },
                    "affiliate":
                    {
                        "network_affiliate_id": 113,
                        "network_id": 1,
                        "name": "Digital Supply",
                        "account_status": "active",
                        "network_traffic_source_id": 0
                    }
                }
            }
        ]
    },
    "raw_click": "",
    "on_hold_conversions":
    {
        "total": 0,
        "entries":
        []
    }
}

Docs: Domains Configuration

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

The Everflow SDK is served from your account’s tracking domain, which makes it simple to use. You simply need to add :

<script type="text/javascript" 
        src="https://www.YOUR-TRACKING-DOMAIN.com/scripts/main.js"></script>

to your page before you can use the features documented here. This is enough for the vast majority of cases.

However, there are scenarios where the configuration can require additional efforts.

Multiple Everflow Accounts

In a typical scenario where a single Everflow account generates a click on a page, there is no need to “identify” the account responsible for the click. The information is inferred from the <script> tag used to include the Everflow SDK. For example :

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN-A.com/scripts/main.js"></script>
<script>
  // This click will be attributed to the account that owns "www.TRACKING-DOMAIN-A.com"
  EF.click({
    offer_id: 1,
    affiliate_id: 1
  });
</script>

Situations may come up where multiple Everflow customers wish to generate a click on the same page (multi-tenant scenarios). The EF.click function takes an optional tracking_domain parameter that can be used to associate clicks with specific accounts, regardless of the account that originally imported the script on the page.

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN-A.com/scripts/main.js"></script>
<script>
  // This click will be attributed to the account that owns "www.TRACKING-DOMAIN-A.com"
  EF.click({
    tracking_domain: "https://www.TRACKING-DOMAIN-A.com",
    offer_id: 1,
    affiliate_id: 1
  });

  // This click will be attributed to the account that owns "www.TRACKING-DOMAIN-B.com"
  EF.click({
    tracking_domain: "https://www.TRACKING-DOMAIN-B.com",
    offer_id: 50,
    affiliate_id: 17
  });
</script>

This also gives you the freedom to extract the offer id / affiliate id information from different URL parameters for different accounts should the need arise. A landing page reached via https://landing-page.com?oid=1&affid=2&offer=10&affiliate=17 could lead to :

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN-A.com/scripts/main.js"></script>
<script>
  EF.click({
    tracking_domain: "https://www.TRACKING-DOMAIN-A.com",
    offer_id: EF.urlParameter('oid'),
    affiliate_id: EF.urlParameter('affid')
  });
  EF.click({
    tracking_domain: "https://www.TRACKING-DOMAIN-B.com",
    offer_id: EF.urlParameter('offer'),
    affiliate_id: EF.urlParameter('affiliate')
  });
</script>

Important : Subdomains must always be specified when using the tracking_domain parameter as apex domains are considered invalid. Use tracking_domain: "www.domain.com", not tracking_domain: "domain.com"

Cookies, Subdomains and Attribution

The Everflow SDK uses different methods to make the attribution as reliable as possible. For that reason, first party cookies created on the domain where the clicks are initially generated. Information is later extracted from that cookie when a conversion occurs. This requires the cookie to be accessible when the EF.conversion(...) code ultimately runs.

When the click occurs on a subdomain that differs from the one where the conversion occurs, the cookie may not be accessible. For example :

User lands on https://shop.your-store.com which generates a click
The Everflow SDK first party cookies the browser using the shop.your-store.com domain
User decides to make a purchase and is redirected to https://payment.your-store.com
User completes the purchase, which generates a conversion (from https://payment.your-store.com)
The Everflow SDK cannot get access to the first party cookie since it is stored on a different subdomain. It must rely on a different attribution mechanism

In such a scenario, it is preferable to store the cookie on the top level domain (your-store.com) rather than on a subdomain (shop.your-store.com) to avoid attribution problems. This is done by using the EF.configure method. In the scenario described above the click code would look like so :

<script type="text/javascript" 
        src="https://www.YOUR-TRACKING-DOMAIN.com/scripts/main.js"></script>
<script>
  EF.configure({
    tld: "your-store.com" // Top level TLD without http(s)
  });

  EF.click({
    offer_id: 5,
    affiliate_id: EF.urlParameter('affid')
  });
</script>

The conversion code would then make use of the same method to fetch the cookie more reliably, regardless of which subdomain the page lives on :

<script type="text/javascript" 
        src="https://www.YOUR-TRACKING-DOMAIN.com/scripts/main.js"></script>
<script>
  // The EF.conversion code will look through all cookies, including the one set at the top level TLD
  EF.conversion({
    offer_id: 5
  });
</script>

Docs: Invalid Click Report

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

The endpoints documented in this section allows you to pull invalid click data from the API. Each row will be representative of a click and the data isn’t aggregated.

Invalid Click Report

The maximum number of clicks that can be returned by this endpoint is : 1 000. If there are more than 1 000 clicks that match the request, they will not be returned.

This endpoint should not be used to extract every click from the platform. Requests to extracts large lists of invalid clicks can be made by reaching out to our support team.

POST /v1/networks/reporting/invalidclicks

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

Optional query filters can be added to the call

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "9",
          "resource_type": "error_code"
      }
    ]
  }
}

translate to “Pull invalid clicks with error code 9 (Invalid country) on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, affilate_id, advertiser, creative, offer_group, campaign, transction_id, error_code

Error codes and their reason for failing can be found here

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/invalidclicks \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Invalid clicks for all partners on 2 offers

{
  "from": "2024-11-31 12:30:00",
  "to": "2024-11-31 13:00:00",
  "timezone_id": 80,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "1522",
        "resource_type": "offer"
      },
      {
        "filter_id_value": "1523",
        "resource_type": "offer"
      }
    ]
  }
}

Example 2 : Invalid clicks that fail because the offer isn’t active being sent to the advertiser

{
  "from": "2024-11-31 12:30:00",
  "to": "2024-11-31 13:00:00",
  "timezone_id": 80,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "1008",
        "resource_type": "error_code"
      },
      {
        "filter_id_value": "10",
        "resource_type": "advertiser"
      }
    ]
  }
}

Response

{
			"transaction_id": "9a1f0ce2b0254752827f605467f543c2",
			"is_unique": 1,
			"unix_timestamp": 1731113091,
			"tracking_url": "www.example-domain.com",
			"source_id": "",
			"sub1": "",
			"sub2": "",
			"sub3": "",
			"sub4": "",
			"sub5": "",
			"payout_type": "",
			"revenue_type": "",
			"payout": 0,
			"revenue": 0,
			"referer": "",
			"previous_network_offer_id": 0,
			"error_code": 1018,
			"project_id": "0069Y0000041PAnQAM",
			"user_ip": "39.23.207.68",
			"error_message": "Anura fraud check categorized click as fraud",
			"url": "",
			"is_view_through": false,
			"is_async": false,
			"server_side_url": "",
			"server_side_output": "",
			"custom_landing_page_id": 0,
			"is_test_mode": false,
			"idfa": "",
			"idfa_md5": "",
			"idfa_sha1": "",
			"google_ad_id": "",
			"google_ad_id_md5": "",
			"google_ad_id_sha1": "",
			"android_id": "",
			"android_id_md5": "",
			"android_id_sha1": "",
			"error_filter_id": "",
			"has_conversion": false,
			"is_pass_through": false,
			"creative_id": 0,
			"relationship": {
				"offer": {
					"network_offer_id": 34,
					"network_id": 1,
					"network_advertiser_id": 64,
					"network_offer_group_id": 0,
					"name": "Test Offer",
					"offer_status": "active",
					"network_tracking_domain_id": 8,
					"visibility": "private",
					"currency_id": "USD"
				},
				"advertiser": {
					"network_advertiser_id": 64,
					"network_id": 1,
					"name": "Example Advertiser",
					"account_status": "active"
				},
				"account_manager": {
					"network_employee_id": 5,
					"network_id": 1,
					"first_name": "Jane",
					"last_name": "Doe",
					"full_name": "Jane Doe",
					"account_status": "inactive"
				},
				"affiliate": {
					"network_affiliate_id": 1,
					"network_id": 1,
					"name": "Example Affiliate",
					"account_status": "active",
					"network_traffic_source_id": 5
				},
				"affiliate_manager": {
					"network_employee_id": 10,
					"network_id": 5,
					"first_name": "Bob",
					"last_name": "Smith",
					"full_name": "Bob Smith",
					"account_status": "active"
				},
				"geolocation": {
					"country_code": "US",
					"country_name": "United States",
					"region_code": "",
					"region_name": "District of Columbia",
					"city_name": "Washington",
					"dma": 0,
					"dma_name": "",
					"timezone": "America/New_York",
					"carrier_name": "",
					"carrier_code": 0,
					"organization": "",
					"isp_name": "Google Cloud",
					"is_mobile": false,
					"is_proxy": true,
					"postal_code": "20011"
				},
				"device_information": {
					"is_mobile": false,
					"platform_name": "Unknown",
					"os_version": "",
					"brand": "Unknown",
					"model": "",
					"is_tablet": false,
					"browser_name": "",
					"browser_version": "",
					"device_type": "PC",
					"language": "",
					"http_accept_language": "",
					"is_robot": false,
					"is_filter": false
				},
				"http_user_agent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)",
				"query_parameters": {},
				"forensiq_score": "0"
			},
			"coupon_code": "",
			"redirect_method": "standard",
			"is_sdk_click": false,
			"category_id": 17,
			"currency_id": "USD"
		}

Docs: Paging

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

Certain endpoints on the Everflow API return paginated responses. When that’s the case, the body of the response will include a paging object

Paging Object

"paging": {
    "page": 2,
    "page_size": 50,
    "total_count": 150
}

The page is a 1-based index (the first page is 1, not 0).

When paging information is not specified in the request, the first page is returned with a page_size of 50. The maximum page size is typically 2000 although some endpoints enforce a smaller maximum.

To request a specific page / page size, you must use the page and page_size in the query string of your request.

For example :

# Network API
curl -H "X-Eflow-API-Key: --your-api-key--" --url "https://api.eflow.team/v1/networks/offers?page=2&page_size=10"

# Affiliate API
curl -H "X-Eflow-API-Key: --your-api-key--" --url "https://api.eflow.team/v1/affiliates/offers?page=2&page_size=10"

Endpoints that return paginated responses are explicitly identified as such in the documentation.

Docs: Raw Conversions Report

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

The endpoints documented in this section allow you to pull conversions and post-conversion events from the API. Each conversion / event will be a “row” in the response as the data is not aggregated.

Note that currency conversion is not supported on raw conversion endpoints. Conversions are always stored in the currency of the offer they belong to and this is how the endpoints return raw conversions.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

Conversion Report

POST /v1/affiliates/reporting/conversions

The conversion report is the most flexible way to extract a list of conversions and post-conversion events. It allows you to fetch a list of conversions and post-conversion events while specifying filters to narrow down the scope of the set of data you are pulling.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)

Please note that the conversion report is limited to the prior 365 days only. Requests outside of this range will result in an error

Optional query filters can be added to the call

Paging

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

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, offer_creative, transaction_id, campaign, sub1, sub2, sub3, sub4, sub5, source_id, country, offer_url, browser, carrier, coupon_code, dma, device_brand, device_type, language, os_version, platform, region

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all conversions (but no events) over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "query":{
        "filters": []
    }
}

Example 2 : Pull conversions and events on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all conversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Response

A response from the conversion report endpoint will look like :

{
	"conversions": [
		{
			"conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
			"conversion_unix_timestamp": 1661970244,
			"sub1": "internal",
			"sub2": "",
			"sub3": "facebook",
			"sub4": "",
			"sub5": "",
			"source_id": "",
			"revenue_type": "CPA",
			"revenue": 0.8,
			"session_user_ip": "217.66.156.135",
			"conversion_user_ip": "",
			"country": "Russia",
			"region": "Sankt-peterburg",
			"city": "St Petersburg",
			"dma": 0,
			"carrier": "MTS Russia",
			"platform": "macOS",
			"os_version": "",
			"device_type": "PC",
			"brand": "Apple",
			"browser": "Safari",
			"language": "en",
			"http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
			"is_event": false,
			"event": "",
			"transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
			"click_unix_timestamp": 1661970238,
			"isp": "mts ojsc",
			"referer": "",
			"app_id": "",
			"idfa": "",
			"idfa_md5": "",
			"idfa_sha1": "",
			"google_ad_id": "",
			"google_ad_id_md5": "",
			"google_ad_id_sha1": "",
			"android_id": "",
			"android_id_md5": "",
			"android_id_sha1": "",
			"currency_id": "USD",
			"is_view_through": false,
			"order_id": "",
			"adv1": "facebook",
			"adv2": "",
			"adv3": "",
			"adv4": "",
			"adv5": "",
			"relationship": {
				"offer": {
					"network_offer_id": 3,
					"network_id": 1,
					"name": "Daily Car",
					"offer_status": "active",
					"network_tracking_domain_id": 1
				},
                "events_count": 0,
                "offer_url": {
                    "network_offer_url_id": 100,
                    "network_id": 1,
                    "network_offer_id": 3,
                    "name": "Alternate Offer URL",
                    "preview_url": "https://example-shop.com"
                }
			}
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

Conversion Report Export

POST /v1/affiliates/reporting/conversions/export

The export endpoint is very similar to the report endpoint documented above but lets you export in CSV or JSON format.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Examples

cURL

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

Example : Export conversions and events on offer 800 in JSON format

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    },
    "format": "json"
}

Conversion By ID

GET /v1/affiliates/reporting/conversions/:conversionId

Fetch a single conversion by its unique conversion ID.

Path Parameters

Parameter	Description
conversionId	The ID of the conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/affiliates/reporting/conversions/<32 char Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
	"conversion_unix_timestamp": 1661970244,
	"sub1": "facebook",
	"sub2": "",
	"sub3": "internal",
	"sub4": "",
	"sub5": "",
	"source_id": "",
	"revenue_type": "CPA",
	"revenue": 0.8,
	"session_user_ip": "217.66.156.135",
	"conversion_user_ip": "",
	"country": "Russia",
	"region": "Sankt-peterburg",
	"city": "St Petersburg",
	"dma": 0,
	"carrier": "MTS Russia",
	"platform": "macOS",
	"os_version": "",
	"device_type": "PC",
	"brand": "Apple",
	"browser": "Safari",
	"language": "en",
	"http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
	"is_event": false,
	"event": "",
	"transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
	"click_unix_timestamp": 1661970238,
	"isp": "mts ojsc",
	"referer": "",
	"app_id": "",
	"idfa": "",
	"idfa_md5": "",
	"idfa_sha1": "",
	"google_ad_id": "",
	"google_ad_id_md5": "",
	"google_ad_id_sha1": "",
	"android_id": "",
	"android_id_md5": "",
	"android_id_sha1": "",
	"currency_id": "USD",
	"is_view_through": false,
	"order_id": "",
	"adv1": "",
	"adv2": "",
	"adv3": "",
	"adv4": "",
	"adv5": "",
	"relationship": {
		"offer": {
			"network_offer_id": 3,
			"network_id": 1,
			"name": "Daily Car",
			"offer_status": "active",
			"network_tracking_domain_id": 1
		},
		"events_count": 0
	},
	"sale_amount": 0,
	"coupon_code": "SUMMER"
}

Docs: Raw Conversions Report

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

Are you looking to fetch all your conversions? If so, the Firehose might be suited for your use case.

Conversion Report

POST /v1/networks/reporting/conversions

If you are only looking to pull a limited set of columns in your response, you must use the Conversion Report Export endpoint documented below.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)

Please note that the conversion report is limited to the prior 365 days only and are limited to a maximum duration of one year. Requests outside of this range will result in an error.

Optional query filters can be added to the call

Paging

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

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, offer_group, affiliate, advertiser, offer_creative, transaction_id, campaign, billing_frequency, business_unit, label, category, sub1, sub2, sub3, sub4, sub5, source_id, country, account_manager, affiliate_manager, status, sales_manager, account_executive, offer_url, currency_id, affiliate_tier, adv1, adv2, adv3, adv4, adv5, browser, carrier, city, coupon_code, dma, device_brand, device_type, isp, language, os_version, platform, region, order_id

Additional Settings

Conversion reports support a few more options :

show_only_scrub : defaults to false when omitted – can be used to isolate conversions that were throttled
show_only_vt : defaults to false when omitted – can be used to isolate view-through conversions
show_only_ct : defaults to false when omitted – can be used to isolate click-through events
show_only_fail_traffic : defaults to false when omitted – can be used to isolate conversion and events that come from fail traffic

{
  "from": "2021-10-12",
  //...
  "show_only_scrub": true,
  "show_only_vt": false,
  "show_only_ct": false,
  "show_only_fail_traffic": false,
  "query": {
    // ...
  }
}

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all approved base conversions over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "query":{
        "filters": [
            {
                "filter_id_value": "approved",
                "resource_type": "status"
            }
        ]
    }
}

Conversion status is either approved, pending, rejected or invalid

Example 2 : Pull pending view-through conversions on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "show_only_vt": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "pending",
                "resource_type": "status"
            },
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all conversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Example 4 : Pull base conversions that were generated from a specific advertiser

{
    "from": "2022-02-01",
    "to": "2022-02-01",
    "timezone_id": 90,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "135",
                "resource_type": "advertiser"
            }
        ]
    }
}

Response

A response from the conversion report endpoint will look like :

{
    "conversions": [
        {
            "conversion_id": "5d6de3955fcd473fa19ddf33ef9a3b8f",
            "conversion_unix_timestamp": 1643691617,
            "sub1": "inapp",
            "sub2": "external",
            "sub3": "",
            "sub4": "",
            "sub5": "facebook",
            "source_id": "1000",
            "status": "approved",
            "payout_type": "cpa",
            "revenue_type": "rpa",
            "payout": 0.8,
            "revenue": 1,
            "session_user_ip": "80.21.15.xxx",
            "conversion_user_ip": "1.2.3.4",
            "country": "Italy",
            "region": "Milano",
            "city": "Arluno",
            "dma": 0,
            "carrier": "",
            "platform": "iOS",
            "os_version": "10.3",
            "device_type": "Mobile",
            "device_model": "",
            "brand": "Apple",
            "browser": "Facebook for iOS",
            "language": "en",
            "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
            "adv1": "",
            "adv2": "",
            "adv3": "",
            "adv4": "",
            "adv5": "",
            "is_event": false,
            "event": "Example Event",
            "notes": "",
            "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
            "click_unix_timestamp": 1643691604,
            "error_code": 0,
            "error_message": "N/A",
            "sale_amount": 96,
            "is_scrub": false,
            "coupon_code": "",
            "order_id": "",
            "url": "",
            "isp": "telecom italia s.p.a.",
            "referer": "",
            "app_id": "",
            "idfa": "",
            "idfa_md5": "",
            "idfa_sha1": "",
            "google_ad_id": "",
            "google_ad_id_md5": "",
            "google_ad_id_sha1": "",
            "android_id": "",
            "android_id_md5": "",
            "android_id_sha1": "",
            "currency_id": "USD",
            "email": "",
            "is_view_through": false,
            "previous_network_offer_id": 0,
            "relationship": {
                "offer": {
                    "network_offer_id": 882,
                    "network_id": 1,
                    "name": "Example Offer",
                    "offer_status": "active"
                },
                "advertiser": {
                    "network_advertiser_id": 135,
                    "network_id": 1,
                    "name": "Advertiser Inc."
                },
                "account_manager": {
                    "network_employee_id": 15,
                    "network_id": 1,
                    "first_name": "John",
                    "last_name": "Doe",
                    "full_name": "John Doe",
                    "account_status": "active"
                },
                "affiliate": {
                    "network_affiliate_id": 102,
                    "network_id": 1,
                    "name": "Affiliate Inc.",
                    "account_status": "active"
                },
                "affiliate_manager": {
                    "network_employee_id": 8,
                    "network_id": 1,
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "full_name": "Jane Doe",
                    "account_status": "active"
                },
                "query_parameters": {},
                "attribution_method": "cookie",
                "usm_data": null
            },
            "network_offer_payout_revenue_id": 0
        },
        // ...
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 3443
    }
}

Conversion Report Export

POST /v1/networks/reporting/conversions/export

The export endpoint is very similar to the report endpoint documented above but adds 2 possibilities :

It lets you “export” the data in CSV or JSON format
It optionally lets your specify the columns you want included in your report

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

The columns that will be included in the response can also be specified. The possible values are : offer, affiliate, advertiser, offer_group, campaign, affiliate_manager, creative, offer_url, category, previous_offer, source_id, sub1, sub2, sub3, sub4, sub5, adv1, adv2, adv3, adv4, adv5, country, region, city, platform, os_version, isp, account_manager, android_id, android_id_md5, android_id_sha1, app_id, brand, browser, carrier, click_date, conversion_id, conversion_user_ip, coupon_code, currency, delta_hours, device, email, error_message, event_name, google_ad_id, google_ad_id_md5, google_ad_id_sha1, http_user_agent, idfa, idfa_md5, idfa_sha1, language, notes, order_id, order_line_items, order_number, payout, payout_type, referrer, revenue, revenue_type, sale_amount, session_ip, transaction_id, type, status, conversion_date and origin

Examples

cURL

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

Example : Export approved conversions on offer 800 in JSON format. Only include 4 specific columns.

{ "from": "2022-02-07", "to": "2022-02-10", "timezone_id": 80, "show_conversions": true, "show_events": true, "show_only_vt": true, "query":{ "filters": [ { "filter_id_value": "approved", "resource_type": "status" }, { "filter_id_value": "800", "resource_type": "offer" } ] }, "columns": [ "offer", "affiliate", "transaction_id", "conversion_id" ], "format": "json"

}

Conversion By ID

GET /v1/networks/reporting/conversions/:conversionId

Fetch a single conversion by its unique conversion ID.

Path Parameters

Parameter	Description
conversionId	The ID of the conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/conversions/<32 char Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "conversion_id": "4b66e71ab68842698fe51002336ff9f9", "conversion_unix_timestamp": 1643692518, "sub1": "internal", "sub2": "gaming", "sub3": "facebook", "sub4": "", "sub5": "", "source_id": "55783", "status": "approved", "payout_type": "cpa", "revenue_type": "rpa", "payout": 3.5, "revenue": 7, "session_user_ip": "208.75.21.101", "conversion_user_ip": "184.151.111.228", "country": "United States", "region": "Michigan", "city": "Ann Arbor", "dma": 505, "carrier": "", "platform": "Android", "os_version": "5.1", "device_type": "Mobile", "device_model": "", "brand": "LG", "browser": "", "language": "", "http_user_agent": "Dalvik/2.1.0 (Linux; U; Android 5.1.1; LG-K330 Build/LMY47V)", "adv1": "", "adv2": "", "adv3": "", "adv4": "", "adv5": "", "is_event": false, "event": "", "notes": "", "transaction_id": "8595ae3b74e841bc9bbcc1560e61283e", "click_unix_timestamp": 1643692502, "error_code": 0, "error_message": "N/A", "sale_amount": 35, "is_scrub": false, "coupon_code": "", "order_id": "", "url": "", "isp": "synergy broadband", "referer": "", "app_id": "", "idfa": "", "idfa_md5": "", "idfa_sha1": "", "google_ad_id": "", "google_ad_id_md5": "", "google_ad_id_sha1": "", "android_id": "", "android_id_md5": "", "android_id_sha1": "", "currency_id": "USD", "email": "", "is_view_through": false, "previous_network_offer_id": 0, "relationship": { "offer": { "network_offer_id": 77, "network_id": 1, "name": "Example Gaming Offer", "offer_status": "active" }, "advertiser": { "network_advertiser_id": 11, "network_id": 1, "name": "Advertiser Inc." }, "account_manager": { "network_employee_id": 15, "network_id": 5, "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "account_status": "active" }, "affiliate": { "network_affiliate_id": 14, "network_id": 1, "name": "Affiliate Inc.", "account_status": "active" }, "affiliate_manager": { "network_employee_id": 87, "network_id": 1, "first_name": "Jane", "last_name": "Doe", "full_name": "Jane Doe", "account_status": "active" }, "query_parameters": { "amount": "3", "nid": "1", "transaction_id": "8595ae3b74e841bc9bbcc1560e61283e" }, "redirect_url": "https://everflow-example.io/?id=8595ae3b74e841bc9bbcc1560e61283e", "snapshots": [ ], "attribution_method": "transaction_id", "usm_data": null }, "network_offer_payout_revenue_id": 0 }

Conversion By Email

POST /v1/networks/reporting/conversions/email

This endpoint can be used to extract a list of conversions / events associated with an email address. The endpoint will return a maximum of 100 conversions (the most recent 100 ones).

Note that conversions older than 1 year may be archived and will not be returned by this endpoint.

The endpoint doesn’t take any filters, only a single email property in the body of the request.

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/conversions/email \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '{
    "email": "test@example.com"
  }'

Response

{
  "conversions": [
    {
      "conversion_id": "1f4a38f373eb12348ba477d3a5b7b65f",
      "conversion_unix_timestamp": 1634568781,
      "sub1": "google",
      "sub2": "facebook",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "source_id": "",
      "status": "approved",
      "payout_type": "cpa",
      "revenue_type": "rpa",
      "payout": 0,
      "revenue": 0,
      "session_user_ip": "1.2.3.4",
      "conversion_user_ip": "10.11.12.13",
      "country": "United States",
      "region": "Wisconsin",
      "city": "Sister Bay",
      "dma": 658,
      "carrier": "",
      "platform": "Android",
      "os_version": "10.0",
      "device_type": "Mobile",
      "device_model": "",
      "brand": "Samsung",
      "browser": "Chrome",
      "language": "en",
      "http_user_agent": "Mozilla/5.0 (Linux; Android 11; SM-G973U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.85 Mobile Safari/537.36",
      "adv1": "",
      "adv2": "",
      "adv3": "",
      "adv4": "",
      "adv5": "",
      "is_event": true,
      "event": "Purchase",
      "notes": "",
      "transaction_id": "78ac316a238b59d48f564431008fd481",
      "click_unix_timestamp": 1634568743,
      "error_code": 0,
      "error_message": "N/A",
      "sale_amount": 0,
      "is_scrub": false,
      "coupon_code": "",
      "order_id": "",
      "url": "",
      "isp": "charter communications",
      "referer": "example.org",
      "app_id": "",
      "idfa": "",
      "idfa_md5": "",
      "idfa_sha1": "",
      "google_ad_id": "",
      "google_ad_id_md5": "",
      "google_ad_id_sha1": "",
      "android_id": "",
      "android_id_md5": "",
      "android_id_sha1": "",
      "currency_id": "USD",
      "email": "test@example.com",
      "is_view_through": false,
      "previous_network_offer_id": 0,
      "relationship": {
        "offer": {
          "network_offer_id": 5,
          "network_id": 1,
          "name": "Example Offer",
          "offer_status": "active"
        },
        "advertiser": {
          "network_advertiser_id": 2,
          "network_id": 1,
          "name": "Advertising Revolution"
        },
        "account_manager": {
          "network_employee_id": 1,
          "network_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "account_status": "active"
        },
        "affiliate": {
          "network_affiliate_id": 10,
          "network_id": 1,
          "name": "Some Affiliate",
          "account_status": "active"
        },
        "affiliate_manager": {
          "network_employee_id": 1,
          "network_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "account_status": "active"
        },
        "query_parameters": {},
        "attribution_method": "unknown",
        "usm_data": null
      },
      "network_offer_payout_revenue_id": 100
    }
  ]
}

Docs: Raw On Hold Conversions Report

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

The endpoints documented in this section allow you to pull on hold conversions and post-conversion events from the API. Each on hold conversion / event will be a “row” in the response as the data is not aggregated.

Note that currency conversion is not supported on raw on hold conversion endpoints. On hold conversions are always stored in the currency of the offer they belong to and this is how the endpoints return raw on hold conversions.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

On Hold Conversion Report

POST /v1/affiliates/reporting/onhold

The on hold conversion report is the most flexible way to extract a list of on hold conversions and post-conversion events. It allows you to fetch a list of on hold conversions and post-conversion events while specifying filters to narrow down the scope of the set of data you are pulling.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)
The on_hold_status_filter used to filter on hold conversions based on their status. It can take the following values : on_hold, approved, rejected. It can be left empty if all on hold conversions need to be returned ("on_hold_status_filter": "").

Please note that the on hold conversion report is limited to the prior 365 days only. Requests outside of this range will result in an error.

Optional query filters can be added to the call

Paging

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

Query Filters

Query filters allow you to limit the scope of the report returned by the API. You could create a filter to limit the reporting data to a single offer for example. You can use multiple filters in a request.

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull on hold conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, transaction_id, campaign, adv1, adv2, adv3, adv4, adv5, offer_creative, coupon_code, dma, date, isp, carrier, sub1, sub2, sub3, sub4, sub5, source_id, language, device_brand, month, browser, country, platform, region, device_type, offer_url, os_version, city, week, country_code

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all on hold conversions (but no events) over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "on_hold_status_filter": "",
    "query":{
        "filters": []
    }
}

Example 2 : Pull pending on hold conversions and events on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "on_hold",
    "query":{
        "filters": [
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all on hold onversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "",
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Response

A response from the on hold conversion report endpoint will look like :

{
	"conversions": [
		{
			"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
            "network_id": 1,
            "holding_period_end": 1661980244,
            "status": "on_hold",
            "conversion": {
                "conversion_id": "",
                "conversion_unix_timestamp": 1661970244,
                "sub1": "internal",
                "sub2": "",
                "sub3": "facebook",
                "sub4": "",
                "sub5": "",
                "source_id": "",
                "revenue_type": "CPA",
                "revenue": 0.8,
                "session_user_ip": "217.66.156.135",
                "conversion_user_ip": "",
                "country": "Russia",
                "region": "Sankt-peterburg",
                "city": "St Petersburg",
                "dma": 0,
                "carrier": "MTS Russia",
                "platform": "macOS",
                "os_version": "",
                "device_type": "PC",
                "brand": "Apple",
                "browser": "Safari",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
                "is_event": false,
                "event": "",
                "transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
                "click_unix_timestamp": 1661970238,
                "isp": "mts ojsc",
                "referer": "",
                "app_id": "",
                "idfa": "",
                "idfa_md5": "",
                "idfa_sha1": "",
                "google_ad_id": "",
                "google_ad_id_md5": "",
                "google_ad_id_sha1": "",
                "android_id": "",
                "android_id_md5": "",
                "android_id_sha1": "",
                "currency_id": "USD",
                "is_view_through": false,
                "order_id": "",
                "adv1": "facebook",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "relationship": {
                    "offer": {
                        "network_offer_id": 3,
                        "network_id": 1,
                        "name": "Daily Car",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1
                    },
                    "events_count": 0,
                    "offer_url": {
                        "network_offer_url_id": 100,
                        "network_id": 1,
                        "network_offer_id": 3,
                        "name": "Alternate Offer URL",
                        "preview_url": "https://example-shop.com"
                    }
                }
            }
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

On Hold Conversion By ID

GET /v1/affiliates/reporting/onhold/:onHoldId

Fetch a single on hold conversion by its unique on hold conversion ID.

Path Parameters

Parameter	Description
onHoldId	The ID of the on hold conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/affiliates/reporting/onhold/<32 char On Hold Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
    "network_id": 1,
    "holding_period_end": 1661980244,
    "status": "on_hold",
    "conversion": {
        "conversion_id": "",
        "conversion_unix_timestamp": 1661970244,
        "sub1": "internal",
        "sub2": "",
        "sub3": "facebook",
        "sub4": "",
        "sub5": "",
        "source_id": "",
        "revenue_type": "CPA",
        "revenue": 0.8,
        "session_user_ip": "217.66.156.135",
        "conversion_user_ip": "",
        "country": "Russia",
        "region": "Sankt-peterburg",
        "city": "St Petersburg",
        "dma": 0,
        "carrier": "MTS Russia",
        "platform": "macOS",
        "os_version": "",
        "device_type": "PC",
        "brand": "Apple",
        "browser": "Safari",
        "language": "en",
        "http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
        "is_event": false,
        "event": "",
        "transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
        "click_unix_timestamp": 1661970238,
        "isp": "mts ojsc",
        "referer": "",
        "app_id": "",
        "idfa": "",
        "idfa_md5": "",
        "idfa_sha1": "",
        "google_ad_id": "",
        "google_ad_id_md5": "",
        "google_ad_id_sha1": "",
        "android_id": "",
        "android_id_md5": "",
        "android_id_sha1": "",
        "currency_id": "USD",
        "is_view_through": false,
        "order_id": "",
        "adv1": "facebook",
        "adv2": "",
        "adv3": "",
        "adv4": "",
        "adv5": "",
        "relationship": {
            "offer": {
                "network_offer_id": 3,
                "network_id": 1,
                "name": "Daily Car",
                "offer_status": "active",
                "network_tracking_domain_id": 1
            },
            "events_count": 0,
            "offer_url": {
                "network_offer_url_id": 100,
                "network_id": 1,
                "network_offer_id": 3,
                "name": "Alternate Offer URL",
                "preview_url": "https://example-shop.com"
            }
        }
    }
}

Docs: Raw On Hold Conversions Report

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

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

On Hold Conversion Report

POST /v1/networks/reporting/onhold

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)
The on_hold_status_filter used to filter on hold conversions based on their status. It can take the following values : on_hold, approved, rejected. It can be left empty if all on hold conversions need to be returned ("on_hold_status_filter": "").

Please note that the on hold conversion report is limited to the prior 365 days only. Requests outside of this range will result in an error.

Optional query filters can be added to the call

Paging

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

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull on hold conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all on hold conversions (but no events) over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "on_hold_status_filter": "",
    "query":{
        "filters": []
    }
}

Example 2 : Pull pending on hold conversions and events on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "on_hold",
    "query":{
        "filters": [
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all on hold onversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "",
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Response

A response from the on hold conversion report endpoint will look like :

{
	"conversions": [
		{
			"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
            "network_id": 1,
            "holding_period_end": 1661980244,
            "status": "on_hold",
            "conversion": {
                "conversion_id": "",
                "conversion_unix_timestamp": 1643691617,
                "sub1": "inapp",
                "sub2": "external",
                "sub3": "",
                "sub4": "",
                "sub5": "facebook",
                "source_id": "1000",
                "status": "",
                "payout_type": "cpa",
                "revenue_type": "rpa",
                "payout": 0.8,
                "revenue": 1,
                "session_user_ip": "80.21.15.xxx",
                "conversion_user_ip": "1.2.3.4",
                "country": "Italy",
                "region": "Milano",
                "city": "Arluno",
                "dma": 0,
                "carrier": "",
                "platform": "iOS",
                "os_version": "10.3",
                "device_type": "Mobile",
                "device_model": "",
                "brand": "Apple",
                "browser": "Facebook for iOS",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
                "adv1": "",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "is_event": false,
                "event": "Example Event",
                "notes": "",
                "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
                "click_unix_timestamp": 1643691604,
                "error_code": 0,
                "error_message": "N/A",
                "sale_amount": 96,
                "is_scrub": false,
                "coupon_code": "",
                "order_id": "",
                "url": "",
                "isp": "telecom italia s.p.a.",
                "referer": "",
                "app_id": "",
                "idfa": "",
                "idfa_md5": "",
                "idfa_sha1": "",
                "google_ad_id": "",
                "google_ad_id_md5": "",
                "google_ad_id_sha1": "",
                "android_id": "",
                "android_id_md5": "",
                "android_id_sha1": "",
                "currency_id": "USD",
                "email": "",
                "is_view_through": false,
                "previous_network_offer_id": 0,
                "relationship": {
                    "offer": {
                        "network_offer_id": 882,
                        "network_id": 1,
                        "name": "Example Offer",
                        "offer_status": "active"
                    },
                    "advertiser": {
                        "network_advertiser_id": 135,
                        "network_id": 1,
                        "name": "Advertiser Inc."
                    },
                    "account_manager": {
                        "network_employee_id": 15,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "affiliate": {
                        "network_affiliate_id": 102,
                        "network_id": 1,
                        "name": "Affiliate Inc.",
                        "account_status": "active"
                    },
                    "affiliate_manager": {
                        "network_employee_id": 8,
                        "network_id": 1,
                        "first_name": "Jane",
                        "last_name": "Doe",
                        "full_name": "Jane Doe",
                        "account_status": "active"
                    },
                    "query_parameters": {},
                    "attribution_method": "cookie",
                    "usm_data": null
                },
                "network_offer_payout_revenue_id": 0
            }
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

On Hold Conversion Report Export

POST /v1/networks/reporting/onhold/export

The export endpoint is very similar to the report endpoint documented above but adds 2 possibilities :

It lets you “export” the data in CSV or JSON format
It optionally lets your specify the columns you want included in your report

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Examples

cURL

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

Example : Export approved on hold conversions on offer 800 in JSON format. Only include 5 specific columns.

{ "from": "2022-02-07", "to": "2022-02-10", "timezone_id": 80, "show_conversions": true, "show_events": true, "on_hold_status_filter": "approved", "query":{ "filters": [ { "filter_id_value": "800", "resource_type": "offer" } ] }, "columns": [ "on_hold_conversion_id", "offer", "affiliate", "transaction_id", "conversion_id" ], "format": "json"

}

On Hold Conversion By ID

GET /v1/networks/reporting/onhold/:onHoldId

Fetch a single on hold conversion by its unique on hold conversion ID.

Path Parameters

Parameter	Description
onHoldId	The ID of the on hold conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/onhold/<32 char On Hold Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
    "network_id": 1,
    "holding_period_end": 1661980244,
    "status": "on_hold",
    "conversion": {
        "conversion_id": "",
        "conversion_unix_timestamp": 1643691617,
        "sub1": "inapp",
        "sub2": "external",
        "sub3": "",
        "sub4": "",
        "sub5": "facebook",
        "source_id": "1000",
        "status": "",
        "payout_type": "cpa",
        "revenue_type": "rpa",
        "payout": 0.8,
        "revenue": 1,
        "session_user_ip": "80.21.15.xxx",
        "conversion_user_ip": "1.2.3.4",
        "country": "Italy",
        "region": "Milano",
        "city": "Arluno",
        "dma": 0,
        "carrier": "",
        "platform": "iOS",
        "os_version": "10.3",
        "device_type": "Mobile",
        "device_model": "",
        "brand": "Apple",
        "browser": "Facebook for iOS",
        "language": "en",
        "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
        "adv1": "",
        "adv2": "",
        "adv3": "",
        "adv4": "",
        "adv5": "",
        "is_event": false,
        "event": "Example Event",
        "notes": "",
        "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
        "click_unix_timestamp": 1643691604,
        "error_code": 0,
        "error_message": "N/A",
        "sale_amount": 96,
        "is_scrub": false,
        "coupon_code": "",
        "order_id": "",
        "url": "",
        "isp": "telecom italia s.p.a.",
        "referer": "",
        "app_id": "",
        "idfa": "",
        "idfa_md5": "",
        "idfa_sha1": "",
        "google_ad_id": "",
        "google_ad_id_md5": "",
        "google_ad_id_sha1": "",
        "android_id": "",
        "android_id_md5": "",
        "android_id_sha1": "",
        "currency_id": "USD",
        "email": "",
        "is_view_through": false,
        "previous_network_offer_id": 0,
        "relationship": {
            "offer": {
                "network_offer_id": 882,
                "network_id": 1,
                "name": "Example Offer",
                "offer_status": "active"
            },
            "advertiser": {
                "network_advertiser_id": 135,
                "network_id": 1,
                "name": "Advertiser Inc."
            },
            "account_manager": {
                "network_employee_id": 15,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "affiliate": {
                "network_affiliate_id": 102,
                "network_id": 1,
                "name": "Affiliate Inc.",
                "account_status": "active"
            },
            "affiliate_manager": {
                "network_employee_id": 8,
                "network_id": 1,
                "first_name": "Jane",
                "last_name": "Doe",
                "full_name": "Jane Doe",
                "account_status": "active"
            },
            "query_parameters": {},
            "attribution_method": "cookie",
            "usm_data": null
        },
        "network_offer_payout_revenue_id": 0
    }
}

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: API Filters

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

API filters can be used on certain “Find” endpoints. When available, the list of fields on which filtering is supported will be supplied in the endpoint’s description.

Usage

Enable a filter by supplying the filter query parameter. The format is the following: ?filter=<field><operator><value>.

Parameter	Description
field	The field to apply the filter on, varies based on endpoint
operator	The operator to apply. Supported operators are listed below
value	The value used by the filter

Operators

Operators are not URL safe so please use the encoded values unless you’re using an URL sanitizer.

Operator	Encoded Value
=	%3D
>	%3E
<	%3C

Code Example

This example demonstrates how to fetch affiliates whose status is active.

curl --request GET 'https://api.eflow.team/v1/networks/affiliates?filter=account_status%3Dactive' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Docs: Organic Tracking

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

The organic tracking feature can be used if you wish to track clicks and conversions that happened without an explicit offer/affiliate context. Here is a simple example of a click that attempts to gather the offer and affiliate ids from the URL.

In a normal scenario, if any of the parameters are not present, it would result in a failure to fire the click. However, since organic tracking is configured, it would instead end up using the offer and affiliate ids provided.

<script type="text/javascript" 
        src="https://www.TRACKING-DOMAIN.com/scripts/main.js"></script>
<script>
  // Organic tracking settings are configured using the "organic" property.
  EF.configure({
    organic: {
      offer_id: 1,
      affiliate_id: 1
    }
  })

  EF.click({
    offer_id: EF.urlParameter('oid'),
    affiliate_id: EF.urlParameter('affid')
  });
</script>

Docs: Raw Impressions Report

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

Are you looking to fetch all your impressions? If so, the Firehose might be suited for your use case.

Impression

POST /v1/networks/reporting/impressions/stream

Only be available to customers who have the impression package.

This endpoint is used to extract a raw list of impressions. In the result of this request each impression will be one element / row. To avoid extremely slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of impressions that can be returned by this endpoint is : 10 000. If there are more than 10 000 impressions that match the request, they will not be returned.

Requests are only allowed for a period of 14 days of less. Requesting a longer period will result in an error (400 bad request).

While the impressions analytics are kept forever, the raw data used to create the response on this endpoint is only kept for a period of 3 months on the Everflow servers. Requests for time intervals that go beyond that period will not return impressions.

This endpoint should not be used to extract every impression from the platform. Requests to extracts large lists of impressions should be made via the Request Report feature.

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, network, account_manager, affiliate_manager, category, billing_frequency, country, region, city, dma, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, isp, offer_status, sub1, sub2, sub3, sub4, sub5, channel, coupon_code, affiliate_tier

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/impressions/stream \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example Pull impressions over a 30 minutes period on 2 specific offers

{
    "from": "2022-02-01 12:30:00",
    "to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ]
    }
}

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: Event Report

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

Event

POST /v1/networks/reporting/postconversions

This endpoint allows the performance reporting to be broken down into events in addition to up to 2 other column types.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A pivot column that will either be event_name or advertiser_event_name depending on the events you are interested in
One or two columns to break down the data

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

Optional query filters can be added to the call.

The columns you request to break down the data will be one or two of the following :

offer, offer_id, offer_group, offer_group_id, creative, creative_id, category, campaign, campaign_id, offer_url, project_id, affiliate, affiliate_id, affiliate_manager, advertiser, advertiser_id, account_manager, sales_manager, account_executive, country, region, city, dma, isp, carrier, connection_type, platform, os_version, device_type, browser, device_make, language, device_model, source_id, referer, sub1, sub2, sub3, sub4, sub5

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull events for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, offer_group, affiliate, advertiser, offer_creative, affiliate_tier, campaign, billing_frequency, business_unit, tracking_domain

Request Example

cURL

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

Request

{
  "from": "2022-02-10",
  "to": "2022-02-10",
  "timezone_id": 67,
  "columns": [
    {
      "column": "offer"
    },
    {
      "column": "affiliate"
    },
    {
      "column": "event_name"
    }
  ],
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      }
    ]
  }
}

Docs: Relationships

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

Endpoints used to fetch information on the Everflow API return objects with a predefined structure. For example, when fetching an affiliate via the Find Affiliate By ID endpoint, only the Affiliate object is returned by default.

{
  "network_affiliate_id": 5,
  "network_id": 1,
  "name": "Google",
  "account_status": "active",
  "...": "..."
}

Relationships are used to extract additional information related to the object being queried. For example, when fetching an affiliate via the Find Affiliate By ID endpoint, requesting the users relationship would allow you to extract the affiliate users on top of the Affiliate object normally returned by the endpoint. The response would then look like :

{
  "network_affiliate_id": 5,
  "network_id": 1,
  "name": "Google",
  "account_status": "active",
  "...": "...",
  "relationship": {
    "users": {
      "total": 1,
      "entries": [
        {
          "network_affiliate_user_id": 12,
          "network_id": 1,
          "network_affiliate_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "...": "..."
        }
      ]
    }
  }
}

Requesting Relationships

You can ask for them using the relationship query parameter.

For example, fetching the affiliate ID 5 in the example above is done by making a GET call to /v1/networks/affiliates/5.

To modify the call and request the users relationship in the example above, the following URL would be queried instead : GET /v1/networks/affiliates/5?relationship=users

Note that multiple relationships can be requested at the same time. For example requesting both the users and signup relationships would be done by calling : GET /v1/networks/affiliates/5?relationship=users&relationship=signup

Availability

Relationships are not available on all endpoints. Endpoints where relationships are offered will be explicitly identified as such on the endpoint documentation.

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: Rulesets

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

A ruleset describes restrictions required for an action to happen, in the case of an offer, the ruleset is used to describe the offer’s targeting settings Offers and some offer related resources containing rules have a relationship key called ruleset.

The ruleset entity contains the following fields:

Geotargeting Rules

countries (find possible values here)
regions (find possible values here)
cities (find possible values here)
dmas (find possible values here)
postal_codes
mobile_carriers (find possible values here)

Device Characteristics Rules

browsers (find possible values here)
device_types (find possible values here)
brands (find possible values here)
os_versions (find possible values here)
platforms (find possible values here)

Connection Information Rules

isp
connection_types (find possible values here)

Matches

Each set of rule have two common fields:

targeting_type : include or exclude
match_type : exact, minimum, maximum or range depending on the type of rule
- exact : supported on countries, regions, cities, dmas, postal_codes, mobile_carriers, browsers, device_types, brands, platforms, ips
- maximum : supported on os_versions
- minimum : supported on os_versions
- range : supported on ips

Order of Precedence

Some rules precede others in the Geotargeting set of rules. The order is based on the specificity of the rule.

The specificity goes City > DMA > ZIP / Postal Code > Region > Country and the matching logic is the following:

As soon as we hit an “Include” for a rule more specific than the following then we don’t need to continue as even Excludes further down the chain are not enough to justify exclusion.

For example, including New York (City) and excluding United States (Country) is the same as just including New York (City).

Day Parting

The ruleset entity also contains fields related to Day Parting. Day Parting allows you to configure windows in which an action can happen.

The fields are the following:

is_use_day_parting
day_parting_apply_to
day_parting_timezone_id
days_parting

is_use_day_parting is a simple boolean flag enabling the day parting

day_parting_apply_to is an optional field, if is_use_day_parting is on, used to specify whether the day parting applies to the user timezone or a specific timezone. Supported values are user_timezone and selected_timezone

day_parting_timezone_id is an optional field, if day_parting_apply_to is set to specific_timezone, used to specify which timezone the day parting is applied to.

days_parting is an optional array field, if is_use_day_parting is on, used to specify rules. There is one entry per window, and there can be multiple windows per day.

For example, the following days_parting entry allows traffic on Tuesdays between 8 AM and 5PM

{
  "day_of_week": 2,
  "start_hour": 8,
  "start_minute": 0,
  "end_hour": 17,
  "end_minute": 0
}

The Ruleset Object

Rulesets are represented by a single json object. It’s the same format that will be used, whether you’re dealing with offer targeting or with custom payout revenue settings targeting.

Below are some examples :

Empty Ruleset

The simplest of all ruleset if one that allows for all traffic to come through. To create an empty ruleset, simply pass an empty json object :

"ruleset": {

}

Simple Rules

Not all types of rules need to be included. You can, for example, only target one type of rule. The following example is for a ruleset that allows traffic from the United States only.

"ruleset": {
  "countries": [
    {
      "country_id": 227,
      "match_type": "exact",
      "targeting_type": "include"
    }
  ]
}

You could target 2 countries at the same time :

"ruleset": {
  "countries": [
    {
      "country_id": 227,
      "match_type": "exact",
      "targeting_type": "include"
    },
    {
      "country_id": 36,
      "match_type": "exact",
      "targeting_type": "include"
    }
  ]
}

Please note that an include rule for "United States" mixed with an exclude rule for "Canada" is redundant as per the explanation in the section above. include "United States" is enough to exclude all other traffic.

Combining Rules

Rules of different types can be used at the same time. Here’s a more complex ruleset that must match ALL the following :

Comes from a device running iOS from version 9.0 to 11.4
Comes from New York City
Is on a mobile connection (as opposed to Wifi)
Is not from a known proxy

"ruleset": {
  "os_versions": [
    {
      "os_version_id": 16,
      "match_type": "minimum",
      "targeting_type": "include",
      "platform_id": 2
    },
    {
      "os_version_id": 33,
      "match_type": "maximum",
      "targeting_type": "include",
      "platform_id": 2
    }
  ],
  "cities": [
    {
      "city_id": 479,
      "match_type": "exact",
      "targeting_type": "include"
    }
  ],
  "connection_types": [
    {
      "match_type": "exact",
      "connection_type_id": 2,
      "targeting_type": "include"
    }
  ],
  "is_block_proxy": true
}

Specific Example : Day Parting

The following ruleset only accepts traffic from Monday to Thursday, 9 AM - 6 PM based on the device user’s timezone :

"ruleset": {
  "is_use_day_parting": true,
  "day_parting_apply_to": "user_timezone",
  "days_parting": [
    {
      "day_of_week": 1,
      "start_hour": 9,
      "end_hour": 18
    },
    {
      "day_of_week": 2,
      "start_hour": 9,
      "end_hour": 18
    },
    {
      "day_of_week": 3,
      "start_hour": 9,
      "end_hour": 18
    },
    {
      "day_of_week": 4,
      "start_hour": 9,
      "end_hour": 18
    }
  ]
}

Only on Saturday from noon until 2 PM UTC (regardless of the device user’s timezone) :

"ruleset": {
  "is_use_day_parting": true,
  "day_parting_apply_to": "selected_timezone",
  "day_parting_timezone_id": 67,
  "days_parting": [
    {
      "day_of_week": 6,
      "start_hour": 12,
      "end_hour": 14
    }
  ]
}

Specific Example : IP Ranges

The following ruleset will exclude all IPs in the [10.11.12.13 to 10.11.12.100] range as well as the 1.2.3.4 address

"ruleset": {
  "ips": [
    {
      "match_type": "range",
      "targeting_type": "exclude",
      "ip_from": "10.11.12.13",
      "ip_to": "10.11.12.100"
    },
    {
      "match_type": "exact",
      "targeting_type": "exclude",
      "ip_from": "1.2.3.4",
      "ip_to": "1.2.3.4"
    }
  ]
}

Specific Example : OS Versions

The following ruleset will allow all traffic from iOS version 12.0 and up

"ruleset": {
  "os_versions": [
    {
      "os_version_id": 34,
      "match_type": "minimum",
      "targeting_type": "include",
      "platform_id": 2
    }
  ]
}

Exclude all traffic Android for versions 7.0 and below

"ruleset": {
  "os_versions": [
    {
      "os_version_id": 7,
      "match_type": "maximum",
      "targeting_type": "exclude",
      "platform_id": 1
    }
  ]
}

Complete Ruleset

Although it’s very unlikely that you would ever want to use a ruleset like this, here is an example of a ruleset that combines every type of rule available :

"ruleset": {
    "platforms": [
        {
            "platform_id": 1,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "device_types": [
        {
            "device_type_id": 3,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "os_versions": [
        {
            "os_version_id": 32,
            "match_type": "minimum",
            "targeting_type": "include",
            "platform_id": 1
        },
        {
            "os_version_id": 45,
            "match_type": "maximum",
            "targeting_type": "include",
            "platform_id": 1
        }
    ],
    "browsers": [
        {
            "browser_id": 2,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "brands": [
        {
            "brand_id": 23,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "postal_codes": [
        {
          "postal_code": "90210",
          "targeting_type": "include",
          "match_type": "exact"
        },
        {
          "postal_code": "90211",
          "targeting_type": "include",
          "match_type": "exact"
        }
    ],
    "languages": [
        {
            "browser_language_id": 10,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "countries": [
        {
            "country_id": 227,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "regions": [
        {
            "region_id": 1140,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "cities": [
        {
            "city_id": 555,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "dmas": [
        {
            "dma_code": 807,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "isps": [
        {
            "isp_id": 3827,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "mobile_carriers": [
        {
            "mobile_carrier_id": 32,
            "match_type": "exact",
            "targeting_type": "include"
        }
    ],
    "connection_types": [
        {
            "match_type": "exact",
            "connection_type_id": 2,
            "targeting_type": "include"
        }
    ],
    "ips": [
        {
            "match_type": "range",
            "targeting_type": "exclude",
            "ip_from": "100.100.100.100",
            "ip_to": "100.100.100.255"
        }
    ],
    "is_use_day_parting": true,
    "is_block_proxy": true,
    "day_parting_apply_to": "selected_timezone",
    "day_parting_timezone_id": 90,
    "days_parting": [
        {
            "day_of_week": 1,
            "start_hour": 8,
            "end_hour": 17
        },
        {
            "day_of_week": 2,
            "start_hour": 8,
            "end_hour": 17
        }
    ]
}

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: Data Supplements

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

The endpoints documented in this section allow you to fetch and manipulate data supplements via the API.

You can learn more about learn more about what data supplements are at the following link: https://helpdesk.everflow.io/customer/data-supplement

Fetch Data Supplements

This endpoint retrieves a structured table of Data Supplements, which represent manual or automated (via integrations) reporting adjustments applied to your network data. Supplements are typically used to correct discrepancies, reconcile billing, or inject offline data into your aggregated reporting statistics.

POST /v1/networks/supplements/table

Optional query filters can be added to the call

Paging

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

Query Filters

{
  "query": {
    "filters": {
      "network_affiliate_ids": [
        10
      ],
      "network_offer_ids": [
        1,
        2
      ],
      "source_ids": [],
      "supplement_source": "generic"
    },
    //...
  }
}

translates to “Pull data supplements associated to offer_id 1 OR offer_id 2 AND network_affiliate_id 10 AND from the supplement_source of Generic”.

In addition to these filters json source details can be queried for as well

{
  "query": {
    //...,
    "search_terms": [
      {
        "search_type": "json_text",
        "value": "Manual: 1"
      }
    ]
  }
}

The above query will look for data supplements with a “source_details_json” value of “manual”: 1.

Body Params

from string

Date from which you want to pull data supplements from. In the format “YYYY-MM-DD”

to string

Date to which you want to pull data supplements from. In the format “YYYY-MM-DD”

timezone_id int

Timezone from which you would like your interval to be pulled from

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Payload

{
	"to": "2026-02-10",
	"from": "2026-02-01",
	"timezone_id": 80,
	"query": {
		"filters": {
			"network_affiliate_ids": [],
			"network_offer_ids": [],
			"source_ids": []
		},
		"search_terms": [
          {
          "search_type": "json_text",
          "value": "parameter1: 1"
          }
        ]
	}
}

Response

{
  "network_data_supplement_id": 1,
  "network_id": 5,
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "currency_id": "USD",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "ctr": 2.333,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "total_cv": 16,
    "event": 5,
    "cvr": 4.571,
    "evr": 31.25,
    "cpc": 0.429,
    "cpm": 10,
    "cpa": 9.375,
    "epc": 0.286,
    "rpc": 0.714,
    "rpa": 15.625,
    "rpm": 16.667,
    "payout": 150,
    "revenue": 250,
    "event_revenue": 50,
    "gross_sales": 500,
    "profit": 100,
    "margin": 40,
    "roas": 2,
    "avg_sale_value": 31.25,
    "media_buying_cost": 120,
    "on_hold_potential_revenue": 0,
    "on_hold_potential_payout": 0,
    "on_hold_conversion_count": 0,
    "public_events": 0
  },
  "network_offer_payout_revenue_id": 0,
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "time_created": 1770766284
}

Export Data Supplements

This endpoint behaves similarly to the endpoint above with 2 caveats:

This endpoint doesn’t deal with paging so will return all data supplements from the query
The data returned from this endpoint will be formatted in either csv or json.

This endpoint takes all the fields from the endpoint listed above with the addition of a format field which will either be csv or json.

POST /v1/networks/supplements/table/stream

Examples

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/table/stream' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Example : Pull all data supplements associated with offer_id 1 and affiliate_id 10 in JSON format.

{
  "format": "json",
  "from": "2026-01-11",
  "query": {
    "filters": {
      "network_affiliate_ids": [
        10
      ],
      "network_offer_ids": [
        1
      ],
      "source_ids": []
    },
    "search_terms": []
  },
  "timezone_id": 80,
  "to": "2026-02-11"
}

Create Data supplements

This endpoint allows you to programmatically inject/ create reporting adjustments into your network’s data.

POST /v1/networks/supplements

Body Params

unix_timestamp int

The timestamp in which you would like the data to be placed in your reporting

supplement_source string

This tells us what source this data supplement is coming from. The allowed value to be coming form the API is “generic”.

source_details_json object

This field will take a json object used to give more context surrounding the data supplement being added. If left empty or emitted will be given the value {}.

network_offer_id int

The Id of the offer you would like this data supplement to be applied to.

network_affiliate_id string

The Id of the affiliate you would like this data supplement to be applied to.

source_id string

The source_id that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub1 string

The sub1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub2 string

The sub2 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub3 string

The sub3 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub4 string

The sub4 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub5 string

The sub5 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv1 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv2 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv3 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv4 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv5 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

reporting object

View Object Details Hide Object Details

imp int

The impression data to be added in reporting. If left empty or emitted will be given the value 0.

total_clicks int

The total_clicks to be added in reporting. If left empty or emitted will be given the value 0.

unique_clicks int

The unique_click total to be added in reporting. If left empty or emitted will be given the value 0.

invalid_click int

The invalid_click total to be added in reporting. If left empty or emitted will be given the value 0.

duplicate_click int

The duplicate_click total to be added in reporting. If left empty or emitted will be given the value 0.

gross_click int

The gross_click total to be added in reporting. If left empty or emitted will be given the value 0.

cv int

The conversion total to be added in reporting. If left empty or emitted will be given the value 0.

invalid_cv_scrub int

The conversion total that was scrubbed/throttled to be added in reporting. If left empty or emitted will be given the value 0.

view_through_cv int

The conversion total that came from view-through traffic to be added in reporting. If left empty or emitted will be given the value 0.

event int

The events total to be added in reporting. If left empty or emitted will be given the value 0.

public_events int

The public_events total to be added in reporting, this won’t be displayed back into the response but is recorded in reporting. If left empty or emitted will be given the value 0.

payout int

The payout total to be added in reporting. If left empty or emitted will be given the value 0.

revenue int

The revenue total to be added in reporting. If left empty or emitted will be given the value 0.

event_revenue int

The event_revenue total to be added in reporting. If left empty or emitted will be given the value 0.

gross_sales int

The gross_sale total to be added in reporting. If left empty or emitted will be given the value 0.

media_buying_cost int

The the media buying spend total to be added in reporting. If left empty or emitted will be given the value 0.

Request Example

cURL

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

{
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "currency_id": "USD",
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "event": 5,
    "public_events": 4,
    "payout": 150.00,
    "revenue": 200.00,
    "event_revenue": 50.00,
    "gross_sales": 500.00,
    "media_buying_cost": 120.00
  }
}

Response

{
  "network_data_supplement_id": 1,
  "network_id": 5,
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "currency_id": "USD",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "ctr": 2.333,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "total_cv": 16,
    "event": 5,
    "cvr": 4.571,
    "evr": 31.25,
    "cpc": 0.429,
    "cpm": 10,
    "cpa": 9.375,
    "epc": 0.286,
    "rpc": 0.714,
    "rpa": 15.625,
    "rpm": 16.667,
    "payout": 150,
    "revenue": 250,
    "event_revenue": 50,
    "gross_sales": 500,
    "profit": 100,
    "margin": 40,
    "roas": 2,
    "avg_sale_value": 31.25,
    "media_buying_cost": 120,
    "on_hold_potential_revenue": 0,
    "on_hold_potential_payout": 0,
    "on_hold_conversion_count": 0,
    "public_events": 0
  },
  "network_offer_payout_revenue_id": 0,
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "time_created": 1770766284
}

Revert Data Supplements

This endpoint allows you to undo or negate previously applied reporting adjustments. By triggering a reversal, you ensure that specific data supplements are removed from your reporting aggregates, effectively restoring the data to its state prior to the adjustment.

POST /v1/networks/supplements/revert

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/revert' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Example Payload

{
  "data_supplement_ids": [
    1,
    2,
    3,
    ...
  ]
}

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: Affiliate Postback

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

In the endpoints documented here, each affiliate postback is a “row” in the response. The data is not aggregated.

Affiliate Postback Report

POST /v1/networks/reporting/affiliate/pixels

This endpoint is used to extract a affiliate postbacks. In the result of this request, each postback will be one element / row. To avoid slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of postbacks that can be returned by this endpoint is : 1000. If there are more than 1000 postbacks for the period / filters requested, they will not be returned. Please use the export streaming endpoint documented below which doesn’t have the same restriction.

Each request must contain :

from and to dates in either the YYYY-mm-DD HH:MM:SS or the YYYY-mm-DD format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
	"query": {
		"filters":[
			{
				"resource_type": "offer",
				"filter_id_value": "15"
			},
			{
				"resource_type": "offer",
				"filter_id_value": "18"
			},
			{
				"resource_type": "affiliate",
				"filter_id_value": "7"
			}
		]
	}
}

translate to “Pull all postback data for affiliate 7 on offers 15 and 18”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values : offer, affiliate and delivery_status

The delivery_status can either be success or failure

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/affiliate/pixels \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Include postbacks for offer ID 11 that succeeded

{
  "timezone_id": 90,
  "from": "2024-02-07",
  "to": "2024-02-08",
  "query":{
    "filters": [
     {
        "resource_type": "offer",
        "filter_id_value": "11"
      },
      {
        "resource_type": "delivery_status",
        "filter_id_value": "success"
      }
    ]
  }
}

Response

{
  "pixels": [
    {
      "network_id": 1,
      "network_offer_id": 11,
      "network_offer_payout_revenue_id": 0,
      "affiliate_id": 7,
      "pixel_id": 132,
      "conversion_id": "a3371dd7b36849cbbfdd9c300b06fdb5",
      "transaction_id": "d5c6feef0d8f489fb91aa5cfb4d64f4e",
      "timestamp": 1707425899,
      "delivery_method": "postback",
      "pixel_level": "global",
      "pixel_status": "active",
      "pixel_type": "conversion",
      "payload": "https://httpbin.org/get?tid=d5c6feef0d8f489fb91aa5cfb4d64f4e",
      "is_success": true,
      "debug_information": "PostbackUrl: https://httpbin.org/get?tid=d5c6feef0d8f489fb91aa5cfb4d64f4e\nStatus: 200\nScheme: \nPath: \nAuthority: \nHeaders: Server: [gunicorn/19.9.0]",
      "last_attempt": 0,
      "failed_attempts": 0,
      "relationship": {
        "offer": {
          "network_offer_id": 11,
          "network_id": 1,
          "network_advertiser_id": 13,
          "network_offer_group_id": 0,
          "name": "Example Offer",
          "offer_status": "active",
          "network_tracking_domain_id": 134,
          "visibility": "public",
          "currency_id": "USD"
        },
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "John Doe Inc.",
          "account_status": "active",
          "network_traffic_source_id": 0
        }
      }  
    }
  ]
}

Affiliate Postback Export

POST /v1/networks/reporting/affiliate/pixels/export

The table export is basically identical to the endpoint documented above, except that it lets you “export” the data in CSV or JSON format and doesn’t limit you to 1000 postbacks.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Example

curl --request POST 'https://api.eflow.team/v1/networks/reporting/affiliate/pixels/export' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "timezone_id": 90,
  "from": "2024-02-07",
  "to": "2024-02-08",
  "query":{
    "filters": [
     {
        "resource_type": "offer",
        "filter_id_value": "11"
      },
      {
        "resource_type": "delivery_status",
        "filter_id_value": "success"
      }
    ]
  },
  "format": "csv"
}'

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
}

Everflow –

Docs: Advertiser Webhooks

Advertiser Created

Payload

Advertiser Updated

Payload

Advertiser Signed Up

Payload

Docs: Advertisers

Find All

Filters

cURL

Response

Find By ID

Relationships

Path Parameters

cURL

Response

Find (Advanced)

Paging

cURL

Response

Create

Update

Path Parameters

Bulk Edit

Body Param

Body Example

cURL

Response

Patch Preview

Response

Patchable Fields

Docs: Aggregated Data Reports

Table

cURL

Table Export

Docs: Aggregated Data Reports

Table

cURL

Table Export

Summary

Reporting Adjustments

Docs: Authentication

Summary

Making Requests

Request Body

Authentication

API Keys

Network API Keys

Affiliate API Keys

Advertiser API Keys

Marketplace API Keys

Docs: Click Tracking

Extracting data from the URL

ITP Workaround And First-Party Cookie Tracking

Custom Parameters

Attribution in Multi-Tenant Scenarios

Advanced Use

Fetching The Transaction ID

Extracting The Transaction ID

Conditional Clicks and Parameters

Docs: Offer Webhooks

Offer Created

Payload

Offer Updated

Payload

Docs: Partner Webhooks

Partner Created

Payload

Partner Updated

Payload

Partner Signed Up

Payload

Partner Sign Up Verdict

Payload

Docs: Advertiser Users

Find All

Path Parameters

Relationships