Everflow – Affiliate API

Docs: Reporting

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

The Everflow UI offers many different types of reports and the API is no different. There is not, however, a one-to-one relationship between every report offered in the UI and the API endpoints as certain API endpoints power many different reports.

Please note that reporting data is subject to Everflow’s data retention policy.

Aggregated Data Reports

Aggregated data reports are the most commonly used reports in Everflow. This endpoint powers reports like :

Offer Report
Sub ID Report
Flex Report

in the Everflow UI. The reports allow you to pivot your data based on the columns of your choice while also applying filters to narrow down the scope of the data returned.

The endpoints that power these reports will allow you to pull data similar to this in the UI

View the aggregated data reports documentation

Aggregated data from the Flex Report

Dashboard Stats

The endpoints documented here power the cards that appear on the dashboard in the Everflow UI after you login.

While these endpoints are not as powerful or granular as the aggregated data reports, they can be useful to quickly pull summaries.

View the dashboard stats documentation

Raw Clicks

These endpoints allow you to pull unaggregated data where each click is a “row” of data.

Clicks can be pulled individually (by transaction id) or in sets. A set of clicks can be pulled at once and each click row will contain details about the event (device information, geolocation, query parameters). The set of clicks pulled can be filtered based on different criterias (offer, sub id value, etc.)

The endpoints documented in this section power the Click Report in the Everflow UI.

View the raw clicks documentation

Raw Conversions

The endpoints allow you to pull unaggregated conversion data where each conversion is a “row” of data.

The set of conversion pulled will contain detailed information about each conversion (revenue information, etc.). The set of conversions pulled can be filtered based on different criterias (offer, country, etc.)

Although it is referred to as the “conversion” report, post-conversion events are also returned by this endpoint.

The conversions can also be extracted in CSV format, effectively mimicking the export functionality from the UI.

View the raw conversions documentation

Raw On Hold Conversions

The endpoints allow you to pull unaggregated on hold conversion data where each on hold conversion is a “row” of data.

The set of on hold conversion pulled will contain detailed information about each on hold conversion (revenue information, etc.). The set of on hold conversions pulled can be filtered based on different criterias (offer, country, etc.)

Although it is referred to as the “on hold conversion” report, post-conversion events are also returned by this endpoint.

View the raw on hold conversions documentation

Docs: Coupon Codes

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

Coupon codes are optional in Everflow but can exist at the offer level. There can be 0, 1 or more coupon codes associated with any given offer.

The coupon codes returned by the API will only be for offers on which you can currently run traffic (i.e. not blocked and not pending approval on the offer).

The “Coupon Code” Object

Though different versions of the deals object are returned by the endpoints documented here, it can be defined as such :

Body Fields

network_coupon_code_id int

The coupon code’s unique identifier

network_id int

The identifier of the network associated with the coupon code

network_offer_id int

The identifier of the offer the coupon code applies to

coupon_code string

The coupon code itself – this is the value that must supplied at the time of the click / conversion that will associate the event to the coupon code.

coupon_status string

Can be active or paused, though at this point only active coupon codes are returned by the endpoints documented here.

tracking_link string

Only relevant if clicks are sent using a coupon code. The tracking link with the coupon code can be used instead of the “standard tracking links” that you would get through the endpoint documented here.

start_date string

An optional start date before which the coupon code is not valid. YYYY-MM-DD format.

end_date string

An optional end date after which the coupon code is not valid. YYYY-MM-DD format.

description string

An optional description of the coupon code. May include HTML code – see the is_description_plain_text field

is_description_plain_text boolean

Determines whether the description field contains HTML code or only plain text.

time_created int

Timestamp (unix time) representing the moment at which the coupon code was created

time_saved int

Timestamp (unix time) representing the moment at which the coupon code was last saved

Get All Coupon Codes

GET /v1/affiliates/couponcodes

This endpoint allows you to fetch the all the active coupon codes you have access to. It will only return coupon codes that are currently active on which you can run traffic.

Returns an empty array if no coupon code exist.

Request Example

cURL

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

Response

{
  "coupon_codes": [
    {
      "network_coupon_code_id": 132,
      "network_id": 1,
      "network_offer_id": 16,
      "coupon_code": "WINTER25",
      "coupon_status": "active",
      "tracking_link": "https://www.example-tracking-link.com/WINTER25/",
      "start_date": "2025-01-01",
      "end_date": "2025-06-01",
      "description": "25% off on all winter jackets",
      "is_description_plain_text": true,
      "time_created": 1585177030,
      "time_saved": 1737590006,
      "relationship": {
        "offer": {
          "network_offer_id": 16,
          "network_id": 1,
          "name": "Winter Jackets",
          "offer_status": "active"
        }
      }
    },
    {
      "network_coupon_code_id": 152,
      "network_id": 1,
      "network_offer_id": 18,
      "coupon_code": "PANTS35",
      "coupon_status": "active",
      "start_date": "",
      "end_date": "",
      "description": "35$ off on <strong>dress pants</strong> at all times",
      "is_description_plain_text": false,
      "tracking_link": "https://www.example-tracking-link.com/PANTS35/",
      "time_created": 1586909228,
      "time_saved": 1586909228,
      "relationship": {
        "offer": {
          "network_offer_id": 18,
          "network_id": 1,
          "name": "Dress Pants",
          "offer_status": "active"
        }
      }
    }
  ]
}

Docs: Deals

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

Deals are optional in Everflow but can exist at the offer level. There can be 0, 1 or more deals associated with any given offer.

The deals will only be accessible on offers on which you can currently run traffic (i.e. not blocked and not pending approval on the offer).

The “Deals” Object

Though different versions of the deals object are returned by the endpoints documented here, it can be defined as such :

Body Fields

network_advertiser_deal_id int

The deal’s unique identifier

network_id int

The identifier of the network associated with the deal

name string

The name of the deal as defined by the network

brand_name string

The name of the brand the deal is associated with. This is currently optional.

deal_type string

The deal type will be one of the following values : coupon, freeshipping, category_coupon, category_sale, product_coupon, product_sale, rebates, clearance, sale, offer, shipping_offer, newcustomer, gift, dollar, percent, dod, apofreeshipping, totallyfreeshipping, mobile, printable, fmtc_exclusive, local, friends_family, revtrax, bogo, category or free_trial

deal_status string

The deal status will be one of the following values : active, inactive or deleted

deal_categories string array

There must be at least one category (but there can be multiple) in the following values :

Deal Categories

alcohol-beer, alcohol-beer-home-brewing, alcohol-beer-liquor-spirits, alcohol-beer-wine, animals-pet-supplies, animals-pet-supplies-bird-supplies, animals-pet-supplies-cat-supplies, animals-pet-supplies-dog-supplies, animals-pet-supplies-horse-supplies, arts-entertainment, arts-entertainment-event-tickets, arts-entertainment-event-tickets-adult-entertainment, arts-entertainment-hobbies-creative-arts, arts-entertainment-party-supplies, auctions, b2b, b2b-advertising-marketing, b2b-construction, b2b-food-service, b2b-janitorial, b2b-medical, b2b-retail, b2b-signage, b2b-web-hosting-domains, b2b-work-safety, babies-kids, babies-kids-baby-health, babies-kids-baby-safety, Babies-kids-baby-toys-activity-equipment, babies-kids-car-seats-carriers-strollers, babies-kids-diapering, babies-kids-nursing-feeding, babies-kids-potty-training, charity, clothing-apparel, clothing-apparel-accessories, clothing-apparel-baby-kids, clothing-apparel-costumes, clothing-apparel-men, clothing-apparel-women, clothing-apparel-work-uniforms, computers-accessories, computers-accessories-accessories, computers-accessories-data-storage, computers-accessories-desktops, computers-accessories-input-devices, computers-accessories-laptops, computers-accessories-monitors, computers-accessories-networking-products, computers-accessories-print-copy-scan-fax, computers-accessories-servers, computers-accessories-software, computers-accessories-tablets, consumer-electronics, consumer-electronics-audio, consumer-electronics-batteries, consumer-electronics-camera-optics, consumer-electronics-drones, consumer-electronics-ereaders, consumer-electronics-electronics-accessories, consumer-electronics-gps, consumer-electronics-home-security-systems, consumer-electronics-projectors, consumer-electronics-smart-home-devices, consumer-electronics-smart-watches, consumer-electronics-telephony, consumer-electronics-video, consumer-electronics-video-game-consoles-games, consumer-electronics-video-players-recorders, consumer-services, consumer-services-box-subscriptions, consumer-services-dating, consumer-services-internet-services, consumer-services-photo-canvas-services, consumer-services-tarot-readings-psychics, covid-related, curbside-pickup, department-stores, education, education-college, education-online-courses, education-school-supplies, erotic, erotic-books-magazines, erotic-clothing, erotic-dvds, erotic-games, erotic-sex-toys, financial, financial-credit-cards, financial-id-protection, financial-insurance, financial-legal, financial-loans, financial-tax-services, food-gourmet, food-gourmet-food-beverage, food-gourmet-restaurants, gambling, gifts, gifts-flowers, gifts-gift-baskets, gifts-gift-certificates, gifts-greeting-cards-stationery, gifts-personalized-gifts, gifts-photo-gifts, green-living-ecofriendly, group-discount, group-discount-age-segment-discount, group-discount-alumni-discount, group-discount-corporate-discount, group-discount-first-responder-discount, group-discount-healthcare-worker-discount, group-discount-hero-discount, group-discount-military-discount, group-discount-student-discount, group-discount-teacher-discount, hardware, hardware-building-supplies, hardware-tools, health-beauty, health-beauty-beauty-cosmetics, health-beauty-contacts-glasses, health-beauty-diet-fitness, health-beauty-fragrance-cologne, health-beauty-health-care, health-beauty-health-care-cdb, health-beauty-personal-care, health-beauty-vitamins-supplements, holidays-occasions, holidays-occasions-4th-of-july, holidays-occasions-april-fools-day, holidays-occasions-australia-day, holidays-occasions-back-to-school, holidays-occasions-black-friday, holidays-occasions-black-friday-in-july, holidays-occasions-boxing-day, holidays-occasions-canada-day, holidays-occasions-chinese-new-year, holidays-occasions-christmas, holidays-occasions-christmas-in-july, holidays-occasions-cinco-de-mayo, holidays-occasions-columbus-day, holidays-occasions-cyber-monday, holidays-occasions-earth-day, holidays-occasions-easter, holidays-occasions-fathers-day, holidays-occasions-free-shipping-day, holidays-occasions-giving-tuesday, holidays-occasions-graduation, holidays-occasions-green-monday, holidays-occasions-halloween, holidays-occasions-hanukkah, holidays-occasions-labor-day, holidays-occasions-leap-day, holidays-occasions-mardi-gras, holidays-occasions-martin-luther-king-day, holidays-occasions-memorial-day, holidays-occasions-mothers-day, holidays-occasions-new-years, holidays-occasions-pink-ribbon-shop, holidays-occasions-presidents-day, holidays-occasions-pride-day, holidays-occasions-prom, holidays-occasions-singles-day, holidays-occasions-st-patricks-day, holidays-occasions-tax-day, holidays-occasions-thanksgiving, holidays-occasions-valentines-day, holidays-occasions-veterans-day, holidays-occasions-weddings, household, household-appliances, household-bed-bath, household-furniture, household-home-decor, household-kitchen-dining, household-lighting, household-rugs-flooring, household-storage-and-organization, household-supplies, household-yard-garden, kids, local-deals, local-deals-apparel, local-deals-automotive, local-deals-babies-kids, local-deals-beauty-spas, local-deals-cannabis, local-deals-computers-electronics, local-deals-education, local-deals-entertainment, local-deals-financial, local-deals-food-drink, local-deals-gifts, local-deals-health-wellness, local-deals-holiday, local-deals-home-services, local-deals-jewelry, local-deals-legal-services, local-deals-nightlife, local-deals-pets, local-deals-photography, local-deals-professional-services, local-deals-public-services, local-deals-real-estate, local-deals-shopping, local-deals-sports-recreation, local-deals-travel, luggage-bags, luggage-bags-backpacks, media, media-books-magazines, media-movies, media-music, mens, office, office-equipment, office-furniture, office-school-supplies, office-supplies, sporting-goods, sporting-goods-athletics, sporting-goods-dance-gymnastics, sporting-goods-exercise-fitness, sporting-goods-indoor-games, sporting-goods-lacrosse, sporting-goods-outdoor-recreation, tobacco, tobacco-cigars, tobacco-ecigarettes-vaporizers, toys-games, toys-games-card-games, toys-games-games, toys-games-outdoor-play-equipment, toys-games-puzzles, toys-games-toys, toys-games-video-games, travel, travel-air, travel-car-rental, travel-cruises, travel-hotel, travel-vacation-packages, vehicles-parts, vehicles-parts-motor-vehicle-electronics, vehicles-parts-motor-vehicle-parts, vehicles-parts-vehicle-insurance, vehicles-parts-vehicle-maintenance-care-decor, vehicles-parts-vehicle-safety-security, vehicles-parts-vehicle-storage-cargo, vehicles-parts-watercraft-parts-accessories, weapons, womens

description string

Optional deal description

restrictions string

Optional restrictions on the deal (expressed as free text)

scope string

The deal scope can be one of the following : entire_store, category or product

coupon_code string

An optional coupon code associated with the deal

coupon_code_discount_percentage int

Only relevant if a coupon code is specified. The coupon code will either be a percentage discount or an amount discount but cannot be both

coupon_code_discount_amount int

Only relevant if a coupon code is specified. The coupon code will either be a percentage discount or an amount discount but cannot be both

coupon_code_discount_currency_id string

Only relevant if a coupon code is specified. The currency specified here is associated with the coupon_code_discount_amount

threshold_quantity int

An optional quantity required to trigger the deal. The threshold can be either an amount or a quantity but cannot be both.

threshold_amount int

An optional amount required to trigger the deal. The threshold can be either an amount or a quantity but cannot be both.

threshold_amount_currency_id string

Only relevant if a threshold_amount is specified. The currency specified here is associated with the threshold_amount

purchase_limit_quantity int

An optional quantity limit associated with the deal. The limit can be either an amount or a quantity but cannot be both.

purchase_limit_amount int

An optional amount limit associated with the deal. The limit can be either an amount or a quantity but cannot be both.

purchase_limit_amount_currency_id string

Only relevant if a purchase_limit_amount is specified. The currency specified here is associated with the purchase_limit_amount

date_valid_from int

Certain deals are only valid for a given period of time. An optional unix timestamp that expresses the date after which the deal becomes valid.

date_valid_to int

Certain deals are only valid for a given period of time. An optional unix timestamp that expresses the date after which the deal has ended.

date_valid_timezone_id int

Only relevant if date_valid_from or date_valid_to are specified. Since both are expressed as unix timestamps via the API this field is not overly relevant in the API. However, it determines how the date is displayed in the UI and can be used as such here.

Get Offer Deals

GET /v1/affiliates/offers/:offerId/deals

This endpoint allows you to fetch the deals associated with an offer if they exist.

Returns an empty array if no deals exist.

Note that the date_valid_from and date_valid_to fields are optional and expressed as unix timestamps. They will be set to 0 if they are not specified.

Request Example

cURL

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

Response

{
	"deals": [
		{
			"network_advertiser_deal_id": 1,
			"network_id": 1,
			"name": "Example Deal",
			"brand_name": "Some brand",
			"deal_type": "coupon",
			"deal_status": "active",
			"deal_categories": [
				"computers-accessories-tablets",
				"computers-accessories-software",
				"computers-accessories-servers"
			],
			"description": "The description of the deal",
			"restrictions": "Some Restrictions (in free text)",
			"scope": "entire_store",
			"coupon_code": "SUMMER23",
			"coupon_code_discount_percentage": 0,
			"coupon_code_discount_amount": 20,
			"coupon_code_discount_currency_id": "USD",
			"threshold_quantity": 0,
			"threshold_amount": 1000,
			"threshold_amount_currency_id": "USD",
			"purchase_limit_quantity": 0,
			"purchase_limit_amount": 0,
			"purchase_limit_amount_currency_id": "",
			"date_valid_from": 1690304400,
			"date_valid_to": 0,
			"date_valid_timezone_id": 80,
			"relationship": {},
			"time_saved": 1690302358,
			"time_created": 1690301385,
			"time_deleted": 0
		}
	]
}

Get All Deals

POST /v1/affiliates/deals

This endpoint allows you to fetch all deals available, with an optional filter of the offer ids.

Returns an empty array if no deals exist.

Paging

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

Body Params

filters object

View Object Details Hide Object Details

network_offer_ids int array

An optional array of offers IDs for which you would like the deals returned.

Request Example

cURL

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

Example 1 : Fetch all deals related to offers with IDs 1 and 2

{
  "filters": {
    "network_offer_ids": [1, 2]
  }
}

Response

{
	"deals": [
		{
			"network_advertiser_deal_id": 1,
			"network_id": 1,
			"name": "Example Deal",
			"brand_name": "Some brand",
			"deal_type": "coupon",
			"deal_status": "active",
			"deal_categories": [
				"computers-accessories-tablets",
				"computers-accessories-software",
				"computers-accessories-servers"
			],
			"description": "The description of the deal",
			"restrictions": "Some Restrictions (in free text)",
			"scope": "entire_store",
			"coupon_code": "SUMMER23",
			"coupon_code_discount_percentage": 0,
			"coupon_code_discount_amount": 20,
			"coupon_code_discount_currency_id": "USD",
			"threshold_quantity": 0,
			"threshold_amount": 1000,
			"threshold_amount_currency_id": "USD",
			"purchase_limit_quantity": 0,
			"purchase_limit_amount": 0,
			"purchase_limit_amount_currency_id": "",
			"date_valid_from": 1690304400,
			"date_valid_to": 0,
			"date_valid_timezone_id": 80,
			"has_products": true,
			"has_locations": true,
			"relationship": {
				"deal_resources": [
					{
						"network_advertiser_deal_resource_id": 2,
						"network_advertiser_deal_id": 1,
						"resource_type": "thumbnail",
						"html_code": "",
						"width": 0,
						"height": 0,
						"relationship": {
							"assets": [
								{
									"network_asset_id": 2,
									"content_type": "image/png",
									"filename": "thumb.png",
									"url": "http://usercontent.everflowclient.io/1/advertisers/1/deal/5/resources/thumb.png",
									"file_size": 11516,
									"image_width": 0,
									"image_height": 0,
									"optimized_thumbnail_url": ""
								}
							]
						}
					},
					{
						"network_advertiser_deal_resource_id": 1,
						"network_advertiser_deal_id": 1,
						"resource_type": "image",
						"html_code": "",
						"width": 0,
						"height": 0,
						"relationship": {
							"assets": [
								{
									"network_asset_id": 1,
									"content_type": "image/png",
									"filename": "slack-preview.png",
									"url": "http://usercontent-dev.everflowclient.io/1/advertisers/1/deal/5/resources/some-image.png",
									"file_size": 274508,
									"image_width": 0,
									"image_height": 0,
									"optimized_thumbnail_url": ""
								}
							]
						}
					}
				],
				"offers": [
					{
						"network_offer_id": 1,
						"network_id": 1,
						"name": "Example Offer",
						"offer_status": "active",
						"tracking_url": "http://www.tracking-link.test/9W598/2CTPL/",
						"redirect_tracking_url": "",
						"impression_tracking_url": ""
					},
					{
						"network_offer_id": 2,
						"network_id": 1,
						"name": "Other offer",
						"offer_status": "active",
						"tracking_url": "http://www.tracking-link.test/9W598/3QQG7/",
						"redirect_tracking_url": "",
						"impression_tracking_url": ""
					}
				],
			},
			"time_saved": 1694616132,
			"time_created": 1694616132,
			"time_deleted": 0
		}
	],
	"paging": {
		"page": 1,
		"page_size": 50,
		"total_count": 1
	}
}

Get Offer Deal by ID

GET /v1/affiliates/offers/:offerId/deals/:dealId

This endpoint allows you to fetch a specific offer deal.

Note that the date_valid_from and date_valid_to fields are optional and expressed as unix timestamps. They will be set to 0 if they are not specified.

Relationships

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

Value	Description
locations	Includes the deal’s locations (if any) in the response
products	Includes the deal’s products (if any) in the response
resources	Includes the deal’s resources (if any) in the response
trackings	Includes the offer’s tracking link in the response

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/offers/<offer_id>/deals/<deal_id>?relationship=locations&relationship=resources&relationship=trackings' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
	"network_advertiser_deal_id": 1,
	"network_id": 1,
	"name": "Example Deal",
	"brand_name": "Some brand",
	"deal_type": "coupon",
	"deal_status": "active",
	"deal_categories": [
		"computers-accessories-tablets",
		"computers-accessories-software",
		"computers-accessories-servers"
	],
	"description": "Public Description",
	"restrictions": "Restrictions (free text)",
	"scope": "entire_store",
	"coupon_code": "SUMMER23",
	"coupon_code_discount_percentage": 0,
	"coupon_code_discount_amount": 20,
	"coupon_code_discount_currency_id": "USD",
	"threshold_quantity": 0,
	"threshold_amount": 1000,
	"threshold_amount_currency_id": "USD",
	"purchase_limit_quantity": 0,
	"purchase_limit_amount": 0,
	"purchase_limit_amount_currency_id": "",
	"date_valid_from": 1690304400,
	"date_valid_to": 0,
	"date_valid_timezone_id": 80,
	"relationship": {
		"deal_locations": [
			{
				"network_advertiser_deal_location_id": 4,
				"network_advertiser_deal_id": 1,
				"business_name": "Example business",
				"street_adress": "",
				"extended_address": "",
				"city": "",
				"region_id": 0,
				"country_id": 0,
				"postal_code": "",
				"business_website": "www.example-biz.net"
			}
		],
		"deal_products": [
			{
				"network_advertiser_deal_product_id": 6,
				"network_advertiser_deal_id": 1,
				"product_name": "Server",
				"product_url": "www.example.test/server",
				"before_discount_price": 549,
				"after_discount_price": 399,
				"retail_price": 599,
				"discount_percentage": 0,
				"price_currency_id": "USD"
			},
			{
				"network_advertiser_deal_product_id": 5,
				"network_advertiser_deal_id": 1,
				"product_name": "Monitor",
				"product_url": "www.example.test/monitor",
				"before_discount_price": 379,
				"after_discount_price": 299,
				"retail_price": 399,
				"discount_percentage": 0,
				"price_currency_id": "USD"
			}
		],
		"deal_resources": [
			{
				"network_advertiser_deal_resource_id": 1,
				"network_advertiser_deal_id": 1,
				"resource_type": "image",
				"html_code": "",
				"width": 200,
				"height": 300,
				"relationship": {
					"assets": [
						{
							"network_asset_id": 2,
							"content_type": "image/jpeg",
							"filename": "d5a38e62-4da3-424f-a5d1-64e9b6c2f934.jpeg",
							"url": "http://usercontent.everflowclient.io/1/advertisers/1/deal/0/resources/d5a38e62-4da3-424f-a5d1-64e9b6c2f934.jpeg",
							"file_size": 574359,
							"image_width": 200,
							"image_height": 300,
							"optimized_thumbnail_url": ""
						}
					]
				}
			}
		],
		"tracking_url": "http://www.servetrack.test/9W598/55M6S/"
	},
	"time_saved": 1690306387,
	"time_created": 1690301385,
	"time_deleted": 0
}

Docs: Encoding / Decoding

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

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

It’s normally not necessary to encode / decode the IDs yourself as the values will be encoded automatically when generating tracking links, etc. However, there are certain situations in which it can be useful to access the information.

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

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

tracking_link_affiliate : the affiliate ID in the context of a tracking link.
tracking_link_offer : the offer ID in the context of a tracking link.
smart_link_affiliate : the affiliate ID in the context of a smartlink.
smart_link_smart_link : the smart link ID in the context of a smartlink tracking link.

Encoding

POST /v1/affiliates/encode

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

Body Params

type string

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

ids int array

The IDs you want to encode

Payload Example

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

Request Example

cURL

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

Response

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

Decoding

POST /v1/affiliates/decode

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

Values that cannot be decoded will return 0.

Body Params

type string

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

ids string array

The encoded IDs you want to decode

Payload Example

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

Request Example

cURL

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

Response

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

Docs: Invoices

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

The “Invoice” Object

The base invoice object is returned on both endpoints documented here.

Body Fields

network_affiliate_invoice_id int

The invoices’ unique identifier

network_id int

The identifier of the network associated with the invoice

affiliate_invoice_status string

The status of the invoice. Can be paid or unpaid

start_time date_time

The start of the period covered by the invoice. YYYY-MM-DD HH:MM:SS format

end_time date_time

The end of the period covered by the invoice. YYYY-MM-DD HH:MM:SS format

timezone_id int

The timezone associated with the invoice period

billed decimal

Note : this field is calculated from the line items and will only be present in the response of the “Get all invoices” endpoint

The total amount of the invoice

paid decimal

Note : this field is calculated from the line items and will only be present in the response of the “Get all invoices” endpoint

The amount of the invoice that has been paid

balance decimal

The amount of the invoice that has not yet been paid

payment_terms string

Conditions of the invoice, e.g. "Net 30"

currency_id string

Currency that applies to the invoice, e.g. "USD"

time_created int

Unix timestamp that represents the invoice’s creation date

time_saved int

Unix timestamp that represents the last time the invoice was modified

Get All Invoices

POST /v1/affiliates/billings/affiliates/invoicestable

This endpoint returns all the invoices that match the filters passed in the payload

Returns an empty array if no invoices match the filters.

Paging

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

Body Params

This endpoint supports query filters but the filters are optional

filters object

View Object Details Hide Object Details

affiliate_invoice_status string

Only return invoices that match the status specified. Can be paid or unpaid

min_start_time string

Only return invoices with a period that starts on or after this date. YYYY-MM-DD format

max_end_time string

Only return invoices with a period that ends on or before this date. YYYY-MM-DD format

min_balance decimal

Only return invoices with a balance above the amount specified

max_balance decimal

Only return invoices with a balance below the amount specified

Request Example

cURL

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

Example 1 : Fetch all unpaid invoices from 2024

{
  "filters":
  {
    "affiliate_invoice_status": "unpaid",
    "min_start_time": "2024-01-01",
    "max_end_time": "2024-12-31"
  }
}

Example 2 : Fetch all invoices with a balance of more than 100$

{
  "filters":
  {
    "min_balance": 100
  }
}

Response

{
  "invoices": [
    {
      "network_affiliate_invoice_id": 1234,
      "network_id": 1,
      "affiliate_invoice_status": "unpaid",
      "start_time": "2024-10-01 00:00:00",
      "end_time": "2024-10-31 23:59:59",
      "timezone_id": 80,
      "balance": 237.43,
      "billed": 237.43,
      "paid": 0,
      "payment_terms": "Net 30",
      "currency_id": "USD",
      "notes": "",
      "time_created": 1667979773,
      "time_saved": 1689685995
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 50,
    "total_count": 1
  }
}

Get Invoice By ID

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

Note that the line items and payments of the invoices will be located in the “relationship” object of the response.

Path Parameters

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

In the invoice details :

The type of each detail (line item) can be referral, offer_detail, vat or adjustment
The payment_type of each payment can be pay for Everflow Pay, paypal, direct_deposit, wire, check, tipalti, veem, masspay, paxum, payoneer, bitcoin, webmoney, capitalist, gift_card, skrill, transferwise or none. Not all payment methods are supported by all networks so possible values are likely a subset of the previous enumeration.

Request Example

cURL

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

Response

{
  "network_affiliate_invoice_id": 10,
  "network_id": 1,
  "network_affiliate_id": 1,
  "status": "unpaid",
  "start_time": "2024-10-01 00:00:00",
  "end_time": "2024-10-31 23:59:59",
  "notes": "Invoice for October",
  "balance": 120.00,
  "timezone_id": 80,
  "currency_id": "USD",
  "time_created": 1731196800,
  "time_saved": 1731196800,
  "relationship": {
    "details": [
      {
        "network_affiliate_invoice_detail_id": 480,
        "network_affiliate_invoice_id": 10,
        "network_offer_id": 0,
        "network_offer_name": "",
        "amount": 20.00,
        "invoice_currency_amount": 20.00,
        "currency_id": "USD",
        "notes": "",
        "quantity": 0,
        "relationship": {
          "referred_affiliate_id": 100,
          "referred_affiliate_name": "Referred John Doe"
        },
        "referral_history_id": 31,
        "type": "referral"
      },
      {
        "network_affiliate_invoice_detail_id": 481,
        "network_affiliate_invoice_id": 10,
        "network_offer_id": 1265,
        "network_offer_name": "Gaming Offer Example",
        "amount": 110.00,
        "invoice_currency_amount": 110.00,
        "currency_id": "USD",
        "notes": "",
        "quantity": 0,
        "referral_history_id": 0,
        "type": "offer_detail"
      }
    ],
    "payments": [
      {
        "network_affiliate_payment_id": 158,
        "network_id": 1,
        "network_affiliate_invoice_id": 10,
        "status": "rejected",
        "notes": "",
        "amount": 120.00,
        "currency": "USD",
        "unix_timestamp": 1731628800,
        "payment_type": "pay"
      },
      {
        "network_affiliate_payment_id": 59,
        "network_id": 1,
        "network_affiliate_invoice_id": 10,
        "status": "pending",
        "notes": "",
        "amount": 120.00,
        "currency": "USD",
        "unix_timestamp": 1731715200,
        "payment_type": "pay"
      }
    ]
  }
}

Docs: Offers

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

Find All Visible

GET /v1/affiliates/alloffers

This endpoint allows you to retrieve a list of all visible offers. This includes public offers and the ones that require your network's approval.

Returns an empty array if no Offers exist or are visible.

Filters

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

Request Example

cURL

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

Response

{
    "offers": [
        {
            "network_offer_id": 1,
            "network_id": 1,
            "name": "Offer Example",
            "thumbnail_url": "",
            "network_category_id": 1,
            "preview_url": "",
            "offer_status": "active",
            "currency_id": "USD",
            "caps_timezone_id": 90,
            "date_live_until": "",
            "html_description": "",
            "is_using_explicit_terms_and_conditions": false,
            "terms_and_conditions": "",
            "is_force_terms_and_conditions": false,
            "visibility": "public",
            "is_caps_enabled": false,
            "is_using_suppression_list": false,
            "suppression_list_id": 0,
            "network_tracking_domain_id": 1,
            "daily_conversion_cap": 0,
            "weekly_conversion_cap": 88,
            "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.5,
            "daily_click_cap": 0,
            "weekly_click_cap": 0,
            "monthly_click_cap": 2500,
            "global_click_cap": 0,
            "tracking_url": "http://www.servetrack.test/9W598/2CTPL/",
            "app_identifier": "",
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "is_description_plain_text": false,
            "is_use_direct_linking": false,
            "relationship": {
                "offer_affiliate_status": "public"
            },
            "impression_tracking_url": ""
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 34
    }
}

Find All Runnable

GET /v1/affiliates/offersrunnable

This endpoint allows you to retrieve a list of all runnable offers. This includes public offers and the ones that have gotten your network's approval.

Returns an empty array if no Offers exist or are runnable.

Paging

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

Request Example

cURL

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

Response

{
  "offers": [
      {
          "network_offer_id": 1,
          "network_id": 1,
          "name": "Offer Example",
          "thumbnail_url": "",
          "network_category_id": 1,
          "preview_url": "",
          "offer_status": "active",
          "currency_id": "USD",
          "caps_timezone_id": 90,
          "date_live_until": "",
          "html_description": "",
          "is_using_explicit_terms_and_conditions": false,
          "terms_and_conditions": "",
          "is_force_terms_and_conditions": false,
          "visibility": "public",
          "is_caps_enabled": false,
          "is_using_suppression_list": false,
          "suppression_list_id": 0,
          "network_tracking_domain_id": 1,
          "daily_conversion_cap": 0,
          "weekly_conversion_cap": 88,
          "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.5,
          "daily_click_cap": 0,
          "weekly_click_cap": 0,
          "monthly_click_cap": 2500,
          "global_click_cap": 0,
          "tracking_url": "http://www.servetrack.test/9W598/2CTPL/",
          "app_identifier": "",
          "time_created": 1602783082,
          "time_saved": 1602783082,
          "is_description_plain_text": false,
          "is_use_direct_linking": false,
          "relationship": {
              "category": {
                  "network_category_id": 1,
                  "network_id": 1,
                  "name": "Finance",
                  "status": "active",
                  "time_created": 1602783082,
                  "time_saved": 1602783082
              },
              "creatives": {
                  "total": 1,
                  "entries": [
                      {
                          "network_offer_creative_id": 2,
                          "network_id": 1,
                          "network_offer_id": 1,
                          "name": "Creative Example",
                          "creative_type": "image",
                          "is_private": false,
                          "creative_status": "active",
                          "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/1/c/2/Screen%20Shot%202020-10-16%20at%2010.49.04%20AM.png",
                          "html_code": "",
                          "width": 0,
                          "height": 0,
                          "email_from": "",
                          "email_subject": "",
                          "time_created": 1602871237,
                          "time_saved": 1602871239,
                          "additional_offer_ids": null,
                          "is_apply_specific_affiliates": false
                      }
                  ]
              },
              "reporting": {
                  "imp": 0,
                  "total_click": 0,
                  "unique_click": 0,
                  "invalid_click": 0,
                  "duplicate_click": 0,
                  "ctr": 0,
                  "cv": 0,
                  "view_through_cv": 0,
                  "event": 0,
                  "cvr": 0,
                  "evr": 0,
                  "rpc": 0,
                  "rpm": 0,
                  "revenue": 0,
                  "redirect_traffic_revenue": 0
              },
              "payouts": {
                  "total": 1,
                  "entries": [
                      {
                          "network_offer_payout_revenue_id": 1,
                          "custom_payout_overwrite": false,
                          "network_custom_payout_revenue_setting_id": 0,
                          "payout_type": "cpa",
                          "entry_name": "Payout Example",
                          "payout_amount": 0.8,
                          "payout_percentage": 0,
                          "is_default": true,
                          "is_postback_disabled": false,
                          "is_enforce_caps": true
                      }
                  ]
              },
              "offer_affiliate_status": "public",
              "ruleset": {
                  "network_id": 1,
                  "network_ruleset_id": 0,
                  "time_created": 0,
                  "time_saved": 0,
                  "platforms": [],
                  "device_types": [],
                  "os_versions": [],
                  "brands": [],
                  "browsers": [],
                  "languages": [],
                  "countries": [],
                  "regions": [],
                  "cities": [],
                  "dmas": [],
                  "mobile_carriers": [],
                  "connection_types": [],
                  "ips": [],
                  "is_block_proxy": false,
                  "is_use_day_parting": false,
                  "day_parting_apply_to": "null_value",
                  "day_parting_timezone_id": 0,
                  "days_parting": [],
                  "isps": []
              },
              "urls": {
                  "total": 0,
                  "entries": []
              },
              "custom_payout_settings": {
                  "total": 0,
                  "entries": []
              },
              "remaining_caps": {
                  "remaining_daily_payout_cap": 10.3,
                  "remaining_daily_conversion_cap": -1,
                  "remaining_daily_click_cap": -1
              },
              "creative_bundle": {
                  "url": "https://everflow.everflowclient.io/creativebundles/QLTw3_5p4hy25NQtPKrBOpN1LN1Qp5Iz"
              },
              "channels": {
                  "total": 0,
                  "entries": []
              },
              "blocked_variables_count": 1,
                  "requirement_kpis": {
                      "total": 0,
                      "entries": []
                  },
              "requirement_tracking_parameters": {
                  "total": 0,
                  "entries": []
              }
          },
          "impression_tracking_url": ""
      }
  ],
  "paging": {
    "page": 0,
    "page_size": 0,
    "total_count": 0
  }
}

Find By ID

GET /v1/affiliates/offers/:offerId

This endpoint allows you to retrieve a visible Offer by ID.

Returns HTTP code 404 if the Offer doesn’t exist or is not visible.

Path Parameters

Parameter	Description
offerId	The ID of the offer you want to fetch

Request Example

cURL

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

Response

{
   "network_offer_id":1,
   "network_id":1,
   "name":"Test Offer",
   "thumbnail_url":"",
   "network_category_id":18,
   "preview_url":"",
   "offer_status":"active",
   "currency_id":"USD",
   "caps_timezone_id":68,
   "date_live_until":"",
   "html_description":"",
   "is_using_explicit_terms_and_conditions":false,
   "terms_and_conditions":"",
   "is_force_terms_and_conditions":false,
   "visibility":"public",
   "is_caps_enabled":false,
   "is_using_suppression_list":false,
   "suppression_list_id":0,
   "network_tracking_domain_id":1,
   "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,
   "tracking_url":"https://www.test.com",
   "app_identifier":"",
   "time_created":1496373274,
   "time_saved":1661965494,
   "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
      },
      "creatives":{
         "total":0,
         "entries":[]
      },
      "reporting":{
         "imp":0,
         "total_click":0,
         "unique_click":0,
         "invalid_click":0,
         "duplicate_click":0,
         "ctr":0,
         "cv":0,
         "view_through_cv":0,
         "event":0,
         "cvr":0,
         "evr":0,
         "rpc":0,
         "rpm":0,
         "revenue":0,
         "redirect_traffic_revenue":0
      },
      "payouts":{
         "total":1,
         "entries":[
            {
               "network_offer_payout_revenue_id":1,
               "custom_payout_overwrite":false,
               "network_custom_payout_revenue_setting_id":0,
               "payout_type":"cpa",
               "entry_name":"",
               "payout_amount":0.015,
               "payout_percentage":0,
               "is_default":true,
               "is_postback_disabled":false,
               "is_enforce_caps":false
            }
         ]
      },
      "offer_affiliate_status":"public",
      "integrations":{
         "optizmo":{
            "mailer_access_key":"https://www.url.com/123321312",
            "optout_link":"https://www.url.com/312312312312312"
         },
         "ezepo":null,
         "invoca":{
            "enabled":false
         },
         "unsubcentral":null
      },
      "ruleset":{
         "network_id":5,
         "network_ruleset_id":0,
         "time_created":0,
         "time_saved":0,
         "platforms":[],
         "device_types":[],
         "os_versions":[],
         "browsers":[],
         "languages":[],
         "countries":[],
         "regions":[],
         "cities":[],
         "dmas":[],
         "mobile_carriers":[],
         "connection_types":[],
         "ips":[],
         "is_block_proxy":false,
         "is_use_day_parting":false,
         "day_parting_apply_to":"null_value",
         "day_parting_timezone_id":0,
         "days_parting":[],
         "isps":[],
         "brands":[],
         "postal_codes":[]
      },
      "urls":{
         "total":2,
         "entries":[
            {
               "network_offer_url_id":147,
               "network_id":1,
               "network_offer_id":1,
               "name":"Test 1",
               "preview_url":""
            },
            {
               "network_offer_url_id":148,
               "network_id":1,
               "network_offer_id":1,
               "name":"test2",
               "preview_url":""
            }
         ]
      },
      "custom_payout_settings":{
         "total":0,
         "entries":[]
      },
      "email":{
         "network_offer_id":1,
         "network_id":1,
         "is_enabled":false,
         "subject_lines":"",
         "from_lines":""
      },
      "email_optout":{
         "network_offer_id":1,
         "network_id":1,
         "is_enabled":false,
         "suppression_file_link":"",
         "unsub_link":""
      },
      "creative_bundle":{
         "url":"https://www.url.com/creativebundles/312312312321"
      },
      "channels":{
         "total":0,
         "entries":[]
      },
      "blocked_variables_count":2,
      "requirement_kpis":{
         "total":0,
         "entries":[]
      },
      "requirement_tracking_parameters":{
         "total":0,
         "entries":[]
      },
      "meta":{
         "network_offer_id":1,
         "network_id":1,
         "app_id":"",
         "meta_platform":"",
         "advertiser_campaign_name":"",
         "bundle_id":"",
         "category":"",
         "store_url":"",
         "score_rating":0,
         "total_rating":0,
         "size":0,
         "developer":"",
         "version":"",
         "is_app_unavailable":true,
         "time_created":1606422919,
         "time_app_data_saved":0,
         "time_saved":1661965494
      },
      "product_feeds": [
        {
          "network_advertiser_product_feed_id": 5,
          "network_id": 1,
          "network_advertiser_id": 65,
          "name": "test rando col",
          "status": "active",
          "file_asset_id": 8,
          "date_valid_from": 0,
          "date_valid_to": 0,
          "date_valid_timezone_id": 90,
          "relationship": {
            "document_file_asset": {
              "network_asset_id": 8,
              "content_type": "text/csv",
              "filename": "products-3.csv",
              "url": "http://usercontent-dev.everflowclient.io/1/advertisers/65/productfeed/products-3.csv",
              "file_size": 654,
              "image_width": 0,
              "image_height": 0,
              "optimized_thumbnail_url": ""
            }
          },
          "time_saved": 1683644302,
          "time_created": 1683644302
        }
      ]
   },
   "impression_tracking_url":"",
   "redirect_tracking_url":""
}

Find Tracking URL

GET /v1/affiliates/offers/:offerId/url/:urlId

This endpoint lets you pull a tracking link for a runnable Offer by Id.

You can supply 0 for the urlId if no extra destination urls exist or if you do not wish to use one.

Returns HTTP code 404 if the Offer doesn’t exist. Returns HTTP code 400 if not allowed to run this Offer.

Path Parameters

Parameter	Description
offerId	The ID of an offer
urlId	The id of an extra destination url

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/affiliates/offers/<INSERT OFFER ID>/url/<INSERT URL ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
    "url": "http://www.servetrack.test/9W598/2CTPL/?uid=1"
}

Find Impression URL

GET /v1/affiliates/offers/:offerId/impressionurl/:urlId

This endpoint lets you pull a tracking link for a runnable Offer by Id.

You can supply 0 for the urlId if no extra destination urls exist or if you do not wish to use one.

Returns HTTP code 404 if the Offer doesn’t exist. Returns HTTP code 400 if not allowed to run this Offer.

Path Parameters

Parameter	Description
offerId	The ID of an offer
urlId	The id of an extra destination url

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/affiliates/offers/<INSERT OFFER ID>/impressionurl/<INSERT URL ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
    "url": "http://www.servetrack.test/i/9W598/2CTPL/?uid=1"
}

Docs: Postbacks

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

Find All

GET /v1/affiliates/pixels

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
network_offer_payout_revenue_id	Filter based on the offer payout & revenue id
pixel_status	Filter based on the pixel status
pixel_type	Filter based on the pixel type
delivery_method	Filter based on the delivery method
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/affiliates/pixels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "pixels": [
        {
            "network_pixel_id": 1,
            "network_id": 1,
            "network_affiliate_id": 7,
            "network_offer_id": 1,
            "network_offer_payout_revenue_id": 0,
            "delivery_method": "postback",
            "pixel_level": "specific",
            "pixel_status": "active",
            "pixel_type": "conversion",
            "postback_url": "https://testpostback.com",
            "html_code": "",
            "delay_ms": 0,
            "time_created": 1603373152,
            "time_saved": 1603373687,
            "relationship": {
                "affiliate": {
                    "network_affiliate_id": 7,
                    "network_id": 1,
                    "name": "Affiliate Example",
                    "account_status": "active",
                    "network_employee_id": 2,
                    "internal_notes": "",
                    "has_notifications": false,
                    "network_traffic_source_id": 0,
                    "account_executive_id": 0,
                    "adress_id": 0,
                    "default_currency_id": "USD",
                    "is_contact_address_enabled": false,
                    "enable_media_cost_tracking_links": true,
                    "time_created": 1602783082,
                    "time_saved": 1602783082,
                    "referrer_id": 0
                },
                "offer": {
                    "network_offer_id": 1,
                    "network_id": 1,
                    "network_advertiser_id": 13,
                    "network_offer_group_id": 0,
                    "name": "Offer Example",
                    "offer_status": "active",
                    "network_tracking_domain_id": 1,
                    "visibility": "public",
                    "currency_id": "USD"
                }
            },
            "facebook_pixel": null
        }
    ]
}

Find By ID

GET /v1/affiliates/pixels/:pixelId

Path Parameters

Parameter	Description
pixelId	The ID of the postback you want to fetch

Request Example

cURL

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

Response

{
    "network_pixel_id": 1,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "specific",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "https://testpostback.com",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603373152,
    "time_saved": 1603373687,
    "relationship": {
        "affiliate": {
            "network_affiliate_id": 7,
            "network_id": 1,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "has_notifications": false,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "USD",
            "is_contact_address_enabled": false,
            "enable_media_cost_tracking_links": true,
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "referrer_id": 0
        },
        "offer": {
            "network_offer_id": 1,
            "network_id": 1,
            "network_advertiser_id": 13,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        }
    },
    "facebook_pixel": null
}

Find (Advanced)

POST /v1/affiliates/pixelstable

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.

value string

The value to search.

filters object

View Object Details Hide Object Details

html_code string

HTML code of the postback.

network_affiliate_id int

ID of the affiliate related to the postback.

network_offer_id int

ID of the offer related to the postback.

postback_url string

Url of the postback. Note that the URL requires http(s)://

network_pixel_id int

ID of the postback.

Request Example

cURL

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

Response

{
    "pixels": [
        {
            "network_pixel_id": 1,
            "network_id": 1,
            "network_offer_payout_revenue_id": 0,
            "delivery_method": "postback",
            "pixel_level": "specific",
            "pixel_status": "active",
            "pixel_type": "conversion",
            "postback_url": "https://testpostback.com",
            "html_code": "",
            "network_affiliate_id": 7,
            "network_affiliate_name": "Affiliate Example",
            "network_offer_id": 1,
            "network_offer_name": "Offer Example",
            "delay_ms": 0,
            "time_created": 1603373152,
            "time_saved": 1603373687,
            "relationship": {}
        },
        {
            "network_pixel_id": 2,
            "network_id": 1,
            "network_offer_payout_revenue_id": 0,
            "delivery_method": "postback",
            "pixel_level": "global",
            "pixel_status": "active",
            "pixel_type": "post_conversion",
            "postback_url": "http://test3.com{sub2}{sub1}",
            "html_code": "",
            "network_affiliate_id": 7,
            "network_affiliate_name": "Affiliate Example",
            "network_offer_id": 0,
            "network_offer_name": "Offer Example",
            "delay_ms": 0,
            "time_created": 1603382705,
            "time_saved": 1603382909,
            "relationship": {}
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 2
    }
}

Create

POST /v1/affiliates/pixels

Body Params

network_offer_id int

ID of the offer related to the postback.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global or specific.

pixel_status string

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

pixel_type string

Determines type of postback. Conversion is fired for the based CV action and Event is for any post-conversion events. CPC is used specifically for individual offers that have CPC payouts, and fires on every unique payable click action. It can be a conversion, post_conversion or cpc.

postback_url string

Url of the postback. Only relevant when postback delivery method is used. Note that the URL requires http(s)://

html_code string

HTML code of the postback. Relevant when delivery method html is used.

delay_ms int

An optional delay (expressed in milliseconds) that the system will wait before firing the postback. Only relevant when postback delivery method is used. The maximum delay allowd is 5 minutes, or 300000 milliseconds.

facebook_pixel object

View Object Details Hide Object Details

network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

pixel_id string

ID of the postback

event_name string

Name of the event.

user_data object array

View Object Details Hide Object Details

field string

Date type of the facebook user. Can be email, phone, gender, date_of_birth, last_name, first_name, city, state, zipcode, country_code, external_id, fbc, fbp, subscription_id, or fb_login_id.

value string

Value associated with a type of data.

custom_data object array

View Object Details Hide Object Details

field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

Payload Example

To create a global postback (that will affect all offers) for conversions, the following payload would work :

{
    "pixel_type": "conversion",
    "pixel_status": "active",
    "pixel_level": "global",
    "delivery_method": "postback",
    "html_code": "",
    "postback_url": "http://postback-url.com?s2={sub2}&s1={sub1}"
}

For a specific event postback, specifying the offer id and the event id is necessary. Here is an example payload :

{
    "network_offer_id": 21,
    "network_offer_payout_revenue_id": 152,
    "delivery_method": "postback",
    "pixel_type": "post_conversion",
    "pixel_status": "active",
    "pixel_level": "specific",
    "html_code": "",
    "postback_url": "http://postback-url.com?s2={sub2}&s1={sub1}"
}

Request Example

cURL

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

Response

{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 11,
    "delivery_method": "postback",
    "pixel_level": "specific",
    "pixel_status": "inactive",
    "pixel_type": "post_conversion",
    "postback_url": "http://test2.com?s2{sub2}&s1={sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603484530,
    "relationship": {
        "offer": {
            "network_offer_id": 1,
            "network_id": 1,
            "network_advertiser_id": 13,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        }
    },
    "facebook_pixel": null
}

Update

PUT /v1/affiliates/pixels/:pixelId

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

Path Parameters

Parameter	Description
pixelId	The ID of the postback you want to update

Body Params

network_offer_id int

ID of the offer related to the postback.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global or specific.

pixel_status string

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

pixel_type string

postback_url string

Url of the postback. Note that the URL requires http(s)://

html_code string

HTML code of the postback.

delay_ms int

facebook_pixel object

View Object Details Hide Object Details

network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

event_name string

Name of the event.

user_data object array

View Object Details Hide Object Details

field string

value string

Value associated with a type of data.

custom_data object array

View Object Details Hide Object Details

field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

Payload Example

{
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "post_conversion",
    "postback_url": "http://test3.com{sub2}{sub1}",
    "html_code": "",
    "facebook_pixel": null
}

Request Example

cURL

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

Response

{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 0,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "post_conversion",
    "postback_url": "http://test3.com{sub2}{sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603485164,
    "relationship": {
        "affiliate": {
            "network_affiliate_id": 7,
            "network_id": 1,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "has_notifications": false,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "USD",
            "is_contact_address_enabled": false,
            "enable_media_cost_tracking_links": true,
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "referrer_id": 0
        }
    },
    "facebook_pixel": null
}

Docs: Product Feeds

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

Product feeds are optional in Everflow but can exist at the offer level. There can be 0, 1 or more product feeds associated with any given offer.

The product feeds will only be accessible on offers on which you can currently run traffic (i.e. not blocked and not pending approval on the offer).

Get Offer Product Feeds

GET /v1/affiliates/offers/:offerId/productfeeds

This endpoint allows you to fetch the product feeds associated with an offer if they exist.

Returns an empty array if no product feeds exist.

Note that the date_valid_from and date_valid_to fields are optional and expressed as unix timestamps. They will be set to 0 if they are not specified.

This does not return the contents of the product feeds, only the metadata associated with it. See the endpoints documented below if the contents of the product feed is needed.

Request Example

cURL

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

Response

{
  "product_feeds": [
    {
      "network_advertiser_product_feed_id": 4,
      "network_id": 1,
      "network_advertiser_id": 13,
      "name": "Example Feed",
      "status": "active",
      "file_asset_id": 7,
      "date_valid_from": 1684072800,
      "date_valid_to": 1693490400,
      "date_valid_timezone_id": 80,
      "relationship": {
        "document_file_asset": {
          "network_asset_id": 7,
          "content_type": "text/csv",
          "filename": "product-feed.csv",
          "url": "http://usercontent.everflowclient.io/path/to/product-feed.csv",
          "file_size": 63702,
          "image_width": 0,
          "image_height": 0,
          "optimized_thumbnail_url": ""
        }
      },
      "time_saved": 1683641508,
      "time_created": 1683577762
    }
  ]
}

Get All Product Feeds

POST /v1/affiliates/productfeeds

This endpoint allows you to fetch all product feeds available, with an optional filter of the offer ids.

Returns an empty array if no product feeds exist.

Paging

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

Body Params

filters object

View Object Details Hide Object Details

network_offer_ids int array

An optional array of offers IDs for which you would like the product feeds returned.

Request Example

cURL

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

Example 1 : Fetch all product feeds related to offers with IDs 1 and 2

{
  "filters": {
    "network_offer_ids": [1, 2]
  }
}

Response

{
  "product_feeds": [
    {
      "network_advertiser_product_feed_id": 1,
      "network_id": 1,
      "network_advertiser_id": 13,
      "name": "Example Product Feed 1",
      "status": "active",
      "file_asset_id": 1,
      "date_valid_from": 0,
      "date_valid_to": 0,
      "date_valid_timezone_id": 90,
      "relationship": {
        "document_file_asset": {
          "network_asset_id": 1,
          "content_type": "text/csv",
          "filename": "pf1.csv",
          "url": "http://usercontent.everflowclient.io/1/advertisers/13/productfeed/pf1.csv",
          "file_size": 58,
          "image_width": 0,
          "image_height": 0,
          "optimized_thumbnail_url": ""
        },
        "offers": [
          {
            "network_offer_id": 1,
            "network_id": 1,
            "name": "Example Offer",
            "offer_status": "active"
          },
          {
            "network_offer_id": 2,
            "network_id": 1,
            "name": "Other Offer",
            "offer_status": "active"
          }
        ]
      },
      "time_saved": 1694612016,
      "time_created": 1694612016
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 50,
    "total_count": 1
  }
}

Get Offer Product Feed by ID

GET /v1/affiliates/offers/:offerId/productfeeds/:productFeedId

This endpoint allows you to fetch a specific product feed.

Note that the date_valid_from and date_valid_to fields are optional and expressed as unix timestamps. They will be set to 0 if they are not specified.

This does not automatically return the contents of the product feed, only the metadata associated with it. The contents of the product feed is either accessible via the endpoint when requesting the relationship, or via the 2 download endpoints documented below.

Relationships

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

Value	Description
product_feed_item	Includes the product feed’s items in the response

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/offers/<offer_id>/productfeeds/<product_feed_id>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
  "network_advertiser_product_feed_id": 4,
  "network_id": 1,
  "network_advertiser_id": 13,
  "name": "Example feed",
  "status": "active",
  "file_asset_id": 7,
  "date_valid_from": 1684072800,
  "date_valid_to": 1693490400,
  "date_valid_timezone_id": 80,
  "relationship": {
    "document_file_asset": {
      "network_asset_id": 7,
      "content_type": "text/csv",
      "filename": "product-feed.csv",
      "url": "http://usercontent.everflowclient.io/path/to/product-feed.csv",
      "file_size": 63702,
      "image_width": 0,
      "image_height": 0,
      "optimized_thumbnail_url": ""
    }
  },
  "time_saved": 1683641508,
  "time_created": 1683577762
}

Download Product Feed contents by ID (standard)

GET /v1/affiliates/offers/:offerId/productfeeds/:productFeedId/download

This endpoint allows you to download the contents of the product feed.

This endpoint will return the CSV file directly, you can therefore expect a Content-Type header of text/csv (unless there is an error in the request).

The CSV file returned here will contain a standard set of columns, regardless of the format that was used by the advertiser when uploading the product feed file. The columns are : sku, name, description, url_link, price, url_link_mobile, image_url, image_url_mobile, brand, availability, date_valid_from, date_valid_to

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/offers/<offer_id>/productfeeds/<product_feed_id>/download' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

The CSV file will be returned directly.

Download Product Feed contents by ID (original)

GET /v1/affiliates/offers/:offerId/productfeeds/:productFeedId/download/original

This endpoint allows you to download the contents of the product feed in the format in which it was uploaded by the advertiser.

This endpoint will return the CSV file directly, you can therefore expect a Content-Type header of text/csv (unless there is an error in the request).

The CSV file returned here will can contain different columns but it guaranteed to contain at least the folowing 4 columns which are required in all product feed files : price, name, url_link, sku

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/offers/<offer_id>/productfeeds/<product_feed_id>/download/original' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

The CSV file will be returned directly.

Docs: Traffic

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

Find All Blocked Offer Sources

GET /v1/affiliates/trafficblocking

This endpoint allows you to retrieve a list of all offer/sub combinations that are blocked.

Returns an empty array if no combination exist.

Filters

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

Value	Description
network_offer_id	Filter based on the offer id
traffic_blocking_status	Filter based on the traffic blocking status
time_created	Filter based on the creation time
time_saved	Filter based on the last update time

Request Example

cURL

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

Response

 {
  "traffic_blocking": [
    {
      "network_offer_id": 0,
      "relationship": {
        "variables": {
          "total": 0,
          "entries": [
            {
              "comparison_method": "begins_with",
              "variable": "",
              "variable_value": ""
            }
          ]
        }
      }
    }
  ]
}

Find All Traffic Controls

GET /v1/affiliates/trafficcontrols

This endpoint allows you to retrieve a list of all the traffic controls that are affecting your offers.

To retrieve the values, use the endpoint with the specific traffic control Id.

Returns an empty array if no traffic control exist.

Request Example

cURL

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

Response

{
    "traffic_controls": [
        {
            "network_traffic_control_id": 1,
            "status": "active",
            "is_apply_all_offers": true,
            "control_type": "blacklist",
            "date_valid_from": "",
            "date_valid_to": "",
            "comparison_method": "contains",
            "variables": [],
            "relationship": {}
        }
    ]
}

Find Traffic Control By ID

GET /v1/affiliates/trafficcontrols/:controlId

This endpoint allows you to retrieve a traffic control, by Id, that is affecting your offers.

Returns HTTP code 404 if the traffic control doesn’t exist.

Path Parameters

Parameter	Description
controlId	The ID of the traffic control you want to fetch

Request Example

cURL

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

Response

{
    "traffic_controls": [
        {
            "network_traffic_control_id": 1,
            "status": "active",
            "is_apply_all_offers": true,
            "control_type": "blacklist",
            "date_valid_from": "",
            "date_valid_to": "",
            "comparison_method": "contains",
            "variables": [],
            "relationship": {}
        }
    ]
}

Find All Blocked Variables

POST /v1/affiliates/blockedvariables

This endpoint list all the variables that are blocking the traffic.

This endpoint includes the values that are blocked at the moment and the ones that were blocked during the selected time interval.

Body Params

network_offer_id int

The offer with block variables.

timezone_id int

Refer to Meta/Timezones for supported timezones.

from string

YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

to string

YYYY-MM-DD or YYYY-MM-DD HH:mm:SS.

Payload Example

{
  "from": "",
  "to": "",
  "timezone_id": 90,
  "network_offer_id": 1
}

Request Example

cURL

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

Response

{
    "variables": [
        {
            "variable": "source_id",
            "value": "test",
            "operator": "contains"
        }
    ]
}