Advertisers

Operations for advertisers

Find All

GET /v1/networks/advertisers

Filters

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

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,
            "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

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",
    "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
        },
        "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.

This endpoint supports accept query filters.

search_terms object array
search_type string

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

value string

The value to search.

filters object
account_status string

Filter advertisers based on a specific account status. Supported values are: active, inactive, pending 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.

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
{
    "draw": 1,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "network_advertiser_id": 13,
            "network_id": 1,
            "name": "Gabielle Deleon Inc.",
            "account_status": "active",
            "account_manager_id": 1,
            "account_manager_name": "Peter Johnson",
            "sales_manager_id": 0,
            "sales_manager_name": "",
            "today_revenue": "$0.00",
            "time_created": 1582295424,
            "time_saved": 1582295424,
            "labels": null,
            "verification_token": ""
        }
    ]
}

Create

POST /v1/networks/advertisers

name string

The name of the advertiser.

account_status string

Status of the advertiser. Can be one of the following values: active , inactive , pending , 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.

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.

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.

contact_address object

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

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.

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.

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.

exposed_variables object
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.

{   
    "account_status": "active",
        "billing": {
            "billing_frequency": "weekly",
            "default_invoice_is_hidden": false,
            "default_payment_terms": 0,
            "details": {
                "day_of_week": 1
            },
            "is_invoice_creation_auto": false
        },
        "contact_address": {
            "address_1": "105 Ocean Avenue",
            "city": "Los Angeles",
            "country_id": 227,
            "region_code": "CA",
            "zip_postal_code": "GHGHGH"
        },
        "default_currency_id": "USD",
        "is_contact_address_enabled": true,
        "labels": [
            "test"
        ],
        "name": "Test Advertiser",
        "network_employee_id": 134,
        "reporting_timezone_id": 67,
        "sales_manager_id": 0,
        "sendNotification": true,
        "settings": {
            "exposed_variables": {
                "affiliate": false,
                "affiliate_id": false,
                "source_id": false,
                "sub1": false,
                "sub2": false,
                "sub3": false,
                "sub4": false,
                "sub5": false
            }
        },
        "users": [
            {
                "account_status": "active",
                "currency_id": "USD",
                "email": "my.everflow@gmail.com",
                "first_name": "Bob",
                "initial_password": "",
                "instant_messaging_id": 0,
                "language_id": 1,
                "last_name": "Smith",
                "network_advertiser_user_id": 0,
                "timezone_id": 80
            }
        ]
}

Update

PUT /v1/networks/advertisers/:advertiserId

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 you want to update

name string

The name of the advertiser.

account_status string

Status of the advertiser. Can be one of the following values: active , inactive , pending , 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.

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.

contact_address object

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

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.

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.

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.

exposed_variables object
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.

{   
    "account_status": "active",
        "billing": {
            "billing_frequency": "weekly",
            "default_invoice_is_hidden": false,
            "default_payment_terms": 0,
            "details": {
                "day_of_week": 1
            },
            "is_invoice_creation_auto": false
        },
        "contact_address": {
            "address_1": "105 Ocean Avenue",
            "city": "Los Angeles",
            "country_id": 227,
            "region_code": "CA",
            "zip_postal_code": "GHGHGH"
        },
        "default_currency_id": "USD",
        "is_contact_address_enabled": true,
        "labels": [
            "test"
        ],
        "name": "Test Advertiser",
        "network_employee_id": 134,
        "reporting_timezone_id": 67,
        "sales_manager_id": 0,
        "sendNotification": true,
        "settings": {
            "exposed_variables": {
                "affiliate": false,
                "affiliate_id": false,
                "source_id": false,
                "sub1": false,
                "sub2": false,
                "sub3": false,
                "sub4": false,
                "sub5": false
            }
        }
}