Advertisers
Find All
/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,
"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 |
/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",
"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)
/v1/networks/advertiserstable
Paging
This endpoint supports paging. Refer to our User Guide for usage.
Body Params
This endpoint supports accept query filters.
The name of the field used for search. Only name is supported.
The value to search.
Filter advertisers based on a specific account status. Supported values are: active, inactive, pending and suspended.
Only include advertisers managed by the specified account managers.
Only include advertisers matching the specified labels.
Filter advertisers based on the specified business units.
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
{
"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
/v1/networks/advertisers
Body Params
The name of the advertiser.
Status of the advertiser. Can be one of the following values: active , inactive , pending , or suspended.
The employee id of the advertiser’s account manager.
Internal notes for the advertiser.
The address id of the advertiser.
Whether or not you want to include a contact address for this advertiser. Defaults to false.
The employee id of the advertiser’s sales manager.
The advertiser’s default currency. Can be found using the metadata API.
The name of the shopping cart or attribution platform that your advertiser uses.
The URL for logging into your advertiser’s platform.
The user name details for logging into your advertiser’s platform.
The timezone used in your advertiser’s platform reporting.
The email address of the accounting contact.
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.
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.
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.
The list of labels associated with the advertiser.
A list of at most one advertiser user to be created along with the advertiser entity.
The advertiser user’s first name
The advertiser user’s last name
The advertiser user’s email. Must be unique among all advertiser users. Is used to log in the platform.
The advertiser user’s account status. Can be either active or inactive.
The advertiser user’s title.
The advertiser user’s work phone number.
The advertiser user’s cell phone number.
The id of an instant messaging platform. Allows you to save their identifier for further reference.
The advertiser user’s instant messaging identifier, if instant_messaging_id was different than 0.
The advertiser user’s language id. This is limited to the value 1 (English).
The advertiser user’s timezone id. Can be found using the metadata API.
The advertiser user’s currency id. Can be found using the metadata API
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 meet the following requirements :
- At least 8 characters
- One non-alphanumeric character
- At least one uppercase
- At least one lowercase
The advertiser’s contact address information. Only required if is_contact_address_enabled” is set to true.
The address first line
The address second line
The city name
The region code. Can be found using the metadata API.
The country code. Can be found using the metadata API.
The ZIP or Postal code.
The advertiser’s billing information.
The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.
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.
The advertiser’s tax id.
Configures automatic invoice creations for the advertiser. Defaults to false.
Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.
Configures whether invoices are hidden from the advertiser by default. Defaults to false.
Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.
Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.
The advertiser’s billing frequency details. Required when billing_frequency is set to anything else than manual or other.
Specifies the day of the week, starting on. Required when “billing_frequency” is set to weekly.
Specifies first the day of the month. Required when billing_frequency is set to bimonthly.
Specifies second the day of the month. Required when billing_frequency is set to bimonthly.
Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.
Specifies the month from which the cycle is set to begin. Required when billing_frequency is set to two_months or quarterly.
Variables exposed in the Advertiser UI.
Whether or not you want to expose the affiliate id variable in the advertiser UI.
Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.
Whether or not you want to expose the Sub1 variable in the advertiser UI.
Whether or not you want to expose the Sub2 variable in the advertiser UI.
Whether or not you want to expose the Sub3 variable in the advertiser UI.
Whether or not you want to expose the Sub4 variable in the advertiser UI.
Whether or not you want to expose the Sub5 variable in the advertiser UI.
Whether or not you want to expose the Source ID variable in the advertiser UI.
Payload Example
{
"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
/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
The name of the advertiser.
Status of the advertiser. Can be one of the following values: active , inactive , pending , or suspended.
The employee id of the advertiser’s account manager.
Internal notes for the advertiser.
The address id of the advertiser.
Whether or not you want to include a contact address for this advertiser. Defaults to false.
The employee id of the advertiser’s sales manager.
The advertiser’s default currency. Can be found using the metadata API.
The name of the shopping cart or attribution platform that your advertiser uses.
The URL for logging into your advertiser’s platform.
The user name details for logging into your advertiser’s platform.
The timezone used in your advertiser’s platform reporting.
The email address of the accounting contact.
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.
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.
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.
The list of labels associated with the advertiser.
The advertiser’s contact address information. Only required if is_contact_address_enabled is set to true.
The address first line
The address second line
The city name
The region code. Can be found using the metadata API.
The country code. Can be found using the metadata API.
The ZIP or Postal code.
The advertiser’s billing information.
The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.
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.
The advertiser’s tax id.
Configures automatic invoice creations for the advertiser. Defaults to false.
Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.
Configures whether invoices are hidden from the advertiser by default. Defaults to false.
Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.
Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.
The advertiser’s billing frequency details. Required when billing_frequency is set to anything else than manual or other.
Specifies the day of the week, starting on. Required when billing_frequency is set to weekly.
Specifies first the day of the month. Required when billing_frequency is set to bimonthly.
Specifies second the day of the month. Required when billing_frequency is set to bimonthly.
Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.
Specifies the month from which the cycle is set to begin. Required when billing_frequency is set to two_months or quarterly.
Variables exposed in the Advertiser UI.
Whether or not you want to expose the affiliate id variable in the advertiser UI.
Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.
Whether or not you want to expose the Sub1 variable in the advertiser UI.
Whether or not you want to expose the Sub2 variable in the advertiser UI.
Whether or not you want to expose the Sub3 variable in the advertiser UI.
Whether or not you want to expose the Sub4 variable in the advertiser UI.
Whether or not you want to expose the Sub5 variable in the advertiser UI.
Whether or not you want to expose the Source ID variable in the advertiser UI.
Payload Example
{
"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
}
}
}
Bulk Edit
/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
IDs of the advertisers to be patched.
List of fields to patch. See here for the list of types and their corresponding values.
Type of the field to patch. See here for the list of types.
Value of the field to patch. See here for the list of values.
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
/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
IDs of the advertisers to be patched.
List of fields to patch. See here for the list of types and their corresponding values.
Type of the field to patch. See here for the list of types.
Value of the field to patch. See here for the list of values.
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
An advertiser part of the patch submission.
ID of the advertiser.
Name of the advertiser.
Status of the change. Can be one of the following values: ok, no_change or error.
Error message for that particular field. Only filled when change_status is error.
Message detailing other changes that will happen as a consequence of the particular change.
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.
ID of the invalid advertiser.
Name of the invalid advertiser.
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
Status of the advertiser. Can be one of the following values: active, inactive or suspended.
The employee ID of the advertiser’s account manager.
The employee ID of the advertiser’s sales manager.
The list of labels associated with the advertiser.
The advertiser’s default currency. Can be found using the metadata API.
Can be one of the following values: first_touch or last_touch.
Can be one of the following values: first_affiliate_attribution or last_affiliate_attribution.
Internal notes for the advertiser.
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.
Whether or not you want to expose the affiliate ID in the advertiser UI.
Whether or not you want to expose the affiliate variables in the advertiser UI. This will expose both the affiliate name and id.
Whether or not you want to expose the Sub1 variable in the advertiser UI.
Whether or not you want to expose the Sub2 variable in the advertiser UI.
Whether or not you want to expose the Sub3 variable in the advertiser UI.
Whether or not you want to expose the Sub4 variable in the advertiser UI.
Whether or not you want to expose the Sub5 variable in the advertiser UI.
Whether or not you want to expose the Source ID variable in the advertiser UI.
The advertiser’s tax id.
The advertiser’s invoicing frequency. Can be one of the following values: weekly, bimonthly, monthly, two_months, quarterly, manual or other.
The advertiser’s billing weekly frequency details. Required when billing_frequency is set to weekly.
Specifies the day of the week, starting on. Required when “billing_frequency” is set to weekly.
The advertiser’s billing bimonthly frequency details. Required when billing_frequency is set to bimonthly.
Specifies first the day of the month. Required when billing_frequency is set to bimonthly.
Specifies second the day of the month. Required when billing_frequency is set to bimonthly.
The advertiser’s billing monthly frequency details. Required when billing_frequency is set to monthly.
Specifies day of the month. Required when billing_frequency is set to monthly, two_months or quarterly.
The advertiser’s billing two months frequency details. Required when billing_frequency is set to two_months.
Specifies day of the month.
Specifies the month from which the cycle is set to begin.
The advertiser’s billing quarterly frequency details. Required when billing_frequency is set to quarterly.
Specifies day of the month.
Specifies the month from which the cycle is set to begin.
Configures automatic invoice creations for the advertiser. Defaults to false.
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.
Configures automatic invoice creation start date. Dates are formatted YYYY-mm-dd. Required if is_invoice_creation_auto is set to true.
Configures how many days to wait for invoice generation after the specified billing period. Defaults to 0.
Configures the number of days that will be used as the payment term on generated invoices. Defaults to 0.
Configures whether invoices are hidden from the advertiser by default. Defaults to false.
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.
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.