Offers
Operations for offers
Find All Runnable Offers
GET
/v1//partners/offersrunnable
This endpoint allows you to retrieve a list of all runnable offers available. This will include offers from all your connections (assuming there are runnable offers for each connection).
Returns an empty array if no offers exist or are runnable.
Paging
This endpoint supports paging. Refer to our User Guide for usage.
Page size is capped at 20 on this endpoint. If a page size larger than 20 is requested, 20 will be used.
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/partners/offersrunnable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
"offers": [
{
"network_offer_id": 1,
"network_id": 3,
"name": "Men's Winter Coat",
"thumbnail_url": "https://assets.efusercontent.com/3/offers/1/thumb/some-jacket.jpg",
"network_category_id": 1,
"preview_url": "",
"offer_status": "active",
"currency_id": "USD",
"caps_timezone_id": 90,
"date_live_until": "",
"html_description": "Made from cotton, brand new and high quality",
"is_using_explicit_terms_and_conditions": false,
"terms_and_conditions": "",
"is_force_terms_and_conditions": false,
"visibility": "public",
"is_caps_enabled": true,
"is_using_suppression_list": false,
"suppression_list_id": 0,
"network_tracking_domain_id": 1626,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 0,
"monthly_conversion_cap": 0,
"global_conversion_cap": 0,
"daily_payout_cap": 10000,
"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://tracking-link.com/QL3F2/2CTPL/",
"app_identifier": "",
"time_created": 1565371837,
"time_saved": 1661156401,
"is_description_plain_text": true,
"is_use_direct_linking": false,
"relationship": {
"category": {
"network_category_id": 1,
"network_id": 33,
"name": "Fashion",
"status": "active",
"time_created": 1565371444,
"time_saved": 1565371444
},
"creatives": {
"total": 0,
"entries": [ ]
},
"reporting": {
"imp": 189,
"total_click": 215,
"unique_click": 100,
"invalid_click": 0,
"duplicate_click": 115,
"ctr": 0,
"cv": 0,
"view_through_cv": 0,
"event": 0,
"cvr": 0,
"evr": 0,
"rpc": 0,
"rpm": 0,
"revenue": 0,
"redirect_traffic_revenue": 0
},
"thumbnail_asset": {
"network_asset_id": 9,
"content_type": "image/jpeg",
"filename": "some-jacket.jpg",
"url": "https://assets.efusercontent.com/3/offers/1/thumb/some-jacket.jpg",
"file_size": 57511,
"image_width": 820,
"image_height": 1000,
"optimized_thumbnail_url": "https://assets.efusercontent.com/thumbnails/3/offers/1/thumb/some-jacket.jpg"
},
"payouts": {
"total": 2,
"entries": [
{
"network_offer_payout_revenue_id": 1,
"custom_payout_overwrite": false,
"network_custom_payout_revenue_setting_id": 0,
"payout_type": "cps",
"entry_name": "Purchase",
"payout_amount": 0,
"payout_percentage": 10,
"is_default": true,
"is_postback_disabled": false,
"is_enforce_caps": true
},
{
"network_offer_payout_revenue_id": 16,
"custom_payout_overwrite": false,
"network_custom_payout_revenue_setting_id": 0,
"payout_type": "cpa",
"entry_name": "Membership Subscription",
"payout_amount": 20,
"payout_percentage": 0,
"is_default": false,
"is_postback_disabled": false,
"is_enforce_caps": false
}
]
},
"offer_affiliate_status": "public",
"ruleset": {
"network_id": 3,
"network_ruleset_id": 1,
"time_created": 1565371837,
"time_saved": 1661156401,
"platforms": [],
"device_types": [],
"os_versions": [],
"browsers": [],
"languages": [],
"countries": [
{
"network_id": 3,
"network_targeting_country_id": 147,
"country_id": 73,
"label": "United Kingdom",
"country_code": "UK",
"targeting_type": "include",
"match_type": "exact"
}
],
"regions": [],
"cities": [
{
"network_id": 3,
"network_targeting_city_id": 14,
"city_id": 1330,
"label": "London (LND)",
"targeting_type": "exclude",
"match_type": "exact"
}
],
"dmas": [],
"mobile_carriers": [],
"connection_types": [],
"ips": [],
"is_block_proxy": true,
"is_use_day_parting": false,
"day_parting_apply_to": "user_timezone",
"day_parting_timezone_id": 90,
"days_parting": [],
"isps": [],
"brands": [],
"postal_codes": []
},
"urls": {
"total": 0,
"entries": []
},
"custom_payout_settings": {
"total": 0,
"entries": []
},
"remaining_caps": {
"remaining_daily_payout_cap": 1000000,
"remaining_daily_conversion_cap": -1,
"remaining_daily_click_cap": -1
},
"creative_bundle": {
"url": "https://some-account.everflowclient.io/creativebundles/f436k3Lcdhg5T238mWHCl9HwvhBWL"
},
"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": 3,
"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": 1600365430,
"time_app_data_saved": 0,
"time_saved": 1661156401
}
},
"impression_tracking_url": "",
"redirect_tracking_url": ""
}
],
"paging": {
"page": 1,
"page_size": 20,
"total_count": 1
}
}
Get Offer by ID
GET
/v1/partners/offers/:networkId/:offerId
This endpoint retrieves details for a specific offer.
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/partners/offers/<network_id/<offer_id>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
"network_offer_id": 1,
"network_id": 3,
"name": "Men's Winter Coat",
"thumbnail_url": "https://assets.efusercontent.com/3/offers/1/thumb/some-jacket.jpg",
"network_category_id": 1,
"preview_url": "",
"offer_status": "active",
"currency_id": "USD",
"caps_timezone_id": 90,
"date_live_until": "",
"html_description": "Made from cotton, brand new and high quality",
"is_using_explicit_terms_and_conditions": false,
"terms_and_conditions": "",
"is_force_terms_and_conditions": false,
"visibility": "public",
"is_caps_enabled": true,
"is_using_suppression_list": false,
"suppression_list_id": 0,
"network_tracking_domain_id": 1626,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 0,
"monthly_conversion_cap": 0,
"global_conversion_cap": 0,
"daily_payout_cap": 10000,
"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://tracking-link.com/QL3F2/2CTPL/",
"app_identifier": "",
"time_created": 1565371837,
"time_saved": 1661156401,
"is_description_plain_text": true,
"is_use_direct_linking": false,
"relationship": {
"category": {
"network_category_id": 1,
"network_id": 33,
"name": "Fashion",
"status": "active",
"time_created": 1565371444,
"time_saved": 1565371444
},
"creatives": {
"total": 0,
"entries": [ ]
},
"reporting": {
"imp": 189,
"total_click": 215,
"unique_click": 100,
"invalid_click": 0,
"duplicate_click": 115,
"ctr": 0,
"cv": 0,
"view_through_cv": 0,
"event": 0,
"cvr": 0,
"evr": 0,
"rpc": 0,
"rpm": 0,
"revenue": 0,
"redirect_traffic_revenue": 0
},
"thumbnail_asset": {
"network_asset_id": 9,
"content_type": "image/jpeg",
"filename": "some-jacket.jpg",
"url": "https://assets.efusercontent.com/3/offers/1/thumb/some-jacket.jpg",
"file_size": 57511,
"image_width": 820,
"image_height": 1000,
"optimized_thumbnail_url": "https://assets.efusercontent.com/thumbnails/3/offers/1/thumb/some-jacket.jpg"
},
"payouts": {
"total": 2,
"entries": [
{
"network_offer_payout_revenue_id": 1,
"custom_payout_overwrite": false,
"network_custom_payout_revenue_setting_id": 0,
"payout_type": "cps",
"entry_name": "Purchase",
"payout_amount": 0,
"payout_percentage": 10,
"is_default": true,
"is_postback_disabled": false,
"is_enforce_caps": true
},
{
"network_offer_payout_revenue_id": 16,
"custom_payout_overwrite": false,
"network_custom_payout_revenue_setting_id": 0,
"payout_type": "cpa",
"entry_name": "Membership Subscription",
"payout_amount": 20,
"payout_percentage": 0,
"is_default": false,
"is_postback_disabled": false,
"is_enforce_caps": false
}
]
},
"offer_affiliate_status": "public",
"ruleset": {
"network_id": 3,
"network_ruleset_id": 1,
"time_created": 1565371837,
"time_saved": 1661156401,
"platforms": [],
"device_types": [],
"os_versions": [],
"browsers": [],
"languages": [],
"countries": [
{
"network_id": 3,
"network_targeting_country_id": 147,
"country_id": 73,
"label": "United Kingdom",
"country_code": "UK",
"targeting_type": "include",
"match_type": "exact"
}
],
"regions": [],
"cities": [
{
"network_id": 3,
"network_targeting_city_id": 14,
"city_id": 1330,
"label": "London (LND)",
"targeting_type": "exclude",
"match_type": "exact"
}
],
"dmas": [],
"mobile_carriers": [],
"connection_types": [],
"ips": [],
"is_block_proxy": true,
"is_use_day_parting": false,
"day_parting_apply_to": "user_timezone",
"day_parting_timezone_id": 90,
"days_parting": [],
"isps": [],
"brands": [],
"postal_codes": []
},
"urls": {
"total": 0,
"entries": []
},
"custom_payout_settings": {
"total": 0,
"entries": []
},
"remaining_caps": {
"remaining_daily_payout_cap": 1000000,
"remaining_daily_conversion_cap": -1,
"remaining_daily_click_cap": -1
},
"creative_bundle": {
"url": "https://some-account.everflowclient.io/creativebundles/f436k3Lcdhg5T238mWHCl9HwvhBWL"
},
"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": 3,
"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": 1600365430,
"time_app_data_saved": 0,
"time_saved": 1661156401
}
},
"impression_tracking_url": "",
"redirect_tracking_url": ""
}