Offers
Operations for offers
Find All Visible
GET
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.
/v1/affiliates/alloffers
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
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.
/v1/affiliates/offersrunnable
Returns an empty array if no Offers exist or are runnable.
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/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
This endpoint allows you to retrieve a visible Offer by ID.
/v1/affiliates/offers/:offerId
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
This endpoint lets you pull a tracking link for a runnable Offer by Id.
/v1/affiliates/offers/:offerId/url/:urlId
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
This endpoint lets you pull a tracking link for a runnable Offer by Id.
/v1/affiliates/offers/:offerId/impressionurl/:urlId
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"
}