Offers
Operations for offers
Find All
GET
/v1/advertisers/offers
This endpoint allows you to retrieve a list of all of your offers.
Returns an empty array if no offer exists.
Filters
This endpoint supports basic filtering. Refer to API filters page for usage.
Relationships
This endpoint supports the following additional relationships. Refer to our User Guide for usage.
This endpoint supports additional relationships. You can ask for them using the relationship query parameter. Multiple relationships can be supplied repeating the relationship query parameter.
| Value | Description |
|---|---|
| category | Includes the offer’s category |
| creatives | Includes the list of offer’s creatives |
| reporting | Includes the offer’s reporting information |
| thumbnail_asset | Includes the offer’s thumbnail asset |
| revenues | Includes the list of offer’s revenues |
| ruleset | Includes the offer’s targeting ruleset |
| remaining_caps | Includes the offer’s caps (remaining) |
| meta | Includes the offer’s meta information |
Request Example
cURL
curl --request GET 'https://api.eflow.team/v1/advertisers/offers' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
"offers": [
{
"network_offer_id": 0,
"network_id": 0,
"name": "",
"thumbnail_url": "",
"network_category_id": 0,
"destination_url": "",
"preview_url": "",
"offer_status": "active",
"currency_id": "",
"caps_timezone_id": 0,
"date_live_until": "",
"html_description": "",
"visibility": "public",
"is_using_explicit_terms_and_conditions": true,
"terms_and_conditions": "",
"is_caps_enabled": true,
"is_using_suppression_list": true,
"suppression_list_id": 0,
"network_tracking_domain_id": 0,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 0,
"monthly_conversion_cap": 0,
"global_conversion_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 0,
"time_saved": 0,
"tracking_url": "",
"relationship": {
"category": {
"network_category_id": 0,
"network_id": 0,
"name": "",
"status": "active",
"time_created": 0,
"time_saved": 0
},
"creatives": {
"total": 0,
"entries": [
{
"network_offer_creative_id": 0,
"network_id": 0,
"network_offer_id": 0,
"name": "",
"creative_type": "image",
"is_private": true,
"creative_status": "active",
"resource_url": "",
"html_code": "",
"width": 0,
"height": 0,
"email_from": "",
"email_subject": "",
"time_created": 0,
"time_saved": 0,
"additional_offer_ids": [
0
],
"is_apply_specific_affiliates": true
}
]
},
"reporting": {
"imp": 0,
"total_click": 0,
"unique_click": 0,
"invalid_click": 0,
"ctr": 0,
"cv": 0,
"event": 0,
"cvr": 0,
"evr": 0,
"cpc": 0,
"cpm": 0,
"cost": 0,
"gross_sales": 0
},
"thumbnail_asset": {
"network_asset_id": 0,
"content_type": "",
"filename": "",
"url": "",
"file_size": 0,
"image_width": 0,
"image_height": 0
},
"revenues": {
"total": 0,
"entries": [
{
"revenue_type": "blank",
"entry_name": "",
"revenue_amount": 0,
"revenue_percentage": 0
}
]
},
"ruleset": {
"network_id": 0,
"network_ruleset_id": 0,
"time_created": 0,
"time_saved": 0,
"platforms": [
{
"network_id": 0,
"network_targeting_platform_id": 0,
"platform_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"device_types": [
{
"network_id": 0,
"network_targeting_device_type_id": 0,
"device_type_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"brands": [
{
"network_id": 0,
"network_targeting_brand_id": 1,
"brand_id": 7,
"label": "Motorola",
"targeting_type": "include",
"match_type": "exact"
}
],
"os_versions": [
{
"network_id": 0,
"network_targeting_os_version_id": 0,
"platform_id": 0,
"os_version_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"browsers": [
{
"network_id": 0,
"network_targeting_browser_id": 0,
"browser_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"languages": [
{
"network_id": 0,
"network_targeting_browser_language_id": 0,
"browser_language_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"countries": [
{
"network_id": 0,
"network_targeting_country_id": 0,
"country_id": 0,
"label": "",
"country_code": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"regions": [
{
"network_id": 0,
"network_targeting_region_id": 0,
"region_id": 0,
"region_code": "",
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"cities": [
{
"network_id": 0,
"network_targeting_city_id": 0,
"city_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"dmas": [
{
"network_id": 0,
"network_targeting_dma_id": 0,
"dma_code": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"mobile_carriers": [
{
"network_id": 0,
"network_targeting_mobile_carrier_id": 0,
"mobile_carrier_id": 0,
"label": "",
"country_id": 0,
"targeting_type": "include",
"match_type": "exact"
}
],
"connection_types": [
{
"network_id": 0,
"network_targeting_connection_type_id": 0,
"connection_type_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"ips": [
{
"network_id": 0,
"network_targeting_ip_id": 0,
"ip_from": "",
"ip_to": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"is_block_proxy": true,
"is_use_day_parting": true,
"day_parting_apply_to": "user_timezone",
"day_parting_timezone_id": 0,
"days_parting": [
{
"network_id": 0,
"network_targeting_day_parting_id": 0,
"day_of_week": 0,
"start_hour": 0,
"start_minute": 0,
"end_hour": 0,
"end_minute": 0
}
],
"isps": [
{
"network_id": 0,
"network_targeting_isp_id": 0,
"isp_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
]
},
"remaining_caps": {
"remaining_daily_payout_cap": 0,
"remaining_daily_revenue_cap": 0,
"remaining_daily_conversion_cap": 0,
"remaining_daily_click_cap": 0,
"remaining_weekly_payout_cap": 0,
"remaining_weekly_revenue_cap": 0,
"remaining_weekly_conversion_cap": 0,
"remaining_weekly_click_cap": 0,
"remaining_monthly_payout_cap": 0,
"remaining_monthly_revenue_cap": 0,
"remaining_monthly_conversion_cap": 0,
"remaining_monthly_click_cap": 0,
"remaining_global_payout_cap": 0,
"remaining_global_revenue_cap": 0,
"remaining_global_conversion_cap": 0,
"remaining_global_click_cap": 0
},
"meta": {
"network_offer_id": 0,
"network_id": 0,
"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": 0,
"time_app_data_saved": 0,
"time_saved": 0
}
}
}
]
}
Find By ID
GET
This endpoint allows you to retrieve an offer by ID.
/v1/advertisers/offers/:offerId
Returns HTTP code 404 if the offer doesn’t exist.
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/adverisers/offers/<INSERT OFFER ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
{
"network_offer_id": 0,
"network_id": 0,
"name": "",
"thumbnail_url": "",
"network_category_id": 0,
"destination_url": "",
"preview_url": "",
"offer_status": "active",
"currency_id": "",
"caps_timezone_id": 0,
"date_live_until": "",
"html_description": "",
"visibility": "public",
"is_using_explicit_terms_and_conditions": true,
"terms_and_conditions": "",
"is_caps_enabled": true,
"is_using_suppression_list": true,
"suppression_list_id": 0,
"network_tracking_domain_id": 0,
"daily_conversion_cap": 0,
"weekly_conversion_cap": 0,
"monthly_conversion_cap": 0,
"global_conversion_cap": 0,
"daily_revenue_cap": 0,
"weekly_revenue_cap": 0,
"monthly_revenue_cap": 0,
"global_revenue_cap": 0,
"daily_click_cap": 0,
"weekly_click_cap": 0,
"monthly_click_cap": 0,
"global_click_cap": 0,
"time_created": 0,
"time_saved": 0,
"tracking_url": "",
"relationship": {
"category": {
"network_category_id": 0,
"network_id": 0,
"name": "",
"status": "active",
"time_created": 0,
"time_saved": 0
},
"creatives": {
"total": 0,
"entries": [
{
"network_offer_creative_id": 0,
"network_id": 0,
"network_offer_id": 0,
"name": "",
"creative_type": "image",
"is_private": true,
"creative_status": "active",
"resource_url": "",
"html_code": "",
"width": 0,
"height": 0,
"email_from": "",
"email_subject": "",
"time_created": 0,
"time_saved": 0,
"additional_offer_ids": [
0
],
"is_apply_specific_affiliates": true
}
]
},
"reporting": {
"imp": 0,
"total_click": 0,
"unique_click": 0,
"invalid_click": 0,
"ctr": 0,
"cv": 0,
"event": 0,
"cvr": 0,
"evr": 0,
"cpc": 0,
"cpm": 0,
"cost": 0,
"gross_sales": 0
},
"thumbnail_asset": {
"network_asset_id": 0,
"content_type": "",
"filename": "",
"url": "",
"file_size": 0,
"image_width": 0,
"image_height": 0
},
"revenues": {
"total": 0,
"entries": [
{
"revenue_type": "blank",
"entry_name": "",
"revenue_amount": 0,
"revenue_percentage": 0
}
]
},
"ruleset": {
"network_id": 0,
"network_ruleset_id": 0,
"time_created": 0,
"time_saved": 0,
"platforms": [
{
"network_id": 0,
"network_targeting_platform_id": 0,
"platform_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"device_types": [
{
"network_id": 0,
"network_targeting_device_type_id": 0,
"device_type_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"brands": [
{
"network_id": 0,
"network_targeting_brand_id": 1,
"brand_id": 7,
"label": "Motorola",
"targeting_type": "include",
"match_type": "exact"
}
],
"os_versions": [
{
"network_id": 0,
"network_targeting_os_version_id": 0,
"platform_id": 0,
"os_version_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"browsers": [
{
"network_id": 0,
"network_targeting_browser_id": 0,
"browser_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"languages": [
{
"network_id": 0,
"network_targeting_browser_language_id": 0,
"browser_language_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"countries": [
{
"network_id": 0,
"network_targeting_country_id": 0,
"country_id": 0,
"label": "",
"country_code": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"regions": [
{
"network_id": 0,
"network_targeting_region_id": 0,
"region_id": 0,
"region_code": "",
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"cities": [
{
"network_id": 0,
"network_targeting_city_id": 0,
"city_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"dmas": [
{
"network_id": 0,
"network_targeting_dma_id": 0,
"dma_code": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"mobile_carriers": [
{
"network_id": 0,
"network_targeting_mobile_carrier_id": 0,
"mobile_carrier_id": 0,
"label": "",
"country_id": 0,
"targeting_type": "include",
"match_type": "exact"
}
],
"connection_types": [
{
"network_id": 0,
"network_targeting_connection_type_id": 0,
"connection_type_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"ips": [
{
"network_id": 0,
"network_targeting_ip_id": 0,
"ip_from": "",
"ip_to": "",
"targeting_type": "include",
"match_type": "exact"
}
],
"is_block_proxy": true,
"is_use_day_parting": true,
"day_parting_apply_to": "user_timezone",
"day_parting_timezone_id": 0,
"days_parting": [
{
"network_id": 0,
"network_targeting_day_parting_id": 0,
"day_of_week": 0,
"start_hour": 0,
"start_minute": 0,
"end_hour": 0,
"end_minute": 0
}
],
"isps": [
{
"network_id": 0,
"network_targeting_isp_id": 0,
"isp_id": 0,
"label": "",
"targeting_type": "include",
"match_type": "exact"
}
]
},
"remaining_caps": {
"remaining_daily_payout_cap": 0,
"remaining_daily_revenue_cap": 0,
"remaining_daily_conversion_cap": 0,
"remaining_daily_click_cap": 0,
"remaining_weekly_payout_cap": 0,
"remaining_weekly_revenue_cap": 0,
"remaining_weekly_conversion_cap": 0,
"remaining_weekly_click_cap": 0,
"remaining_monthly_payout_cap": 0,
"remaining_monthly_revenue_cap": 0,
"remaining_monthly_conversion_cap": 0,
"remaining_monthly_click_cap": 0,
"remaining_global_payout_cap": 0,
"remaining_global_revenue_cap": 0,
"remaining_global_conversion_cap": 0,
"remaining_global_click_cap": 0
},
"meta": {
"network_offer_id": 0,
"network_id": 0,
"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": 0,
"time_app_data_saved": 0,
"time_saved": 0
}
}
}