curl --request POST \
--url https://api.eflow.team/v1/networks/offers \
--header 'Content-Type: application/json' \
--header 'X-Eflow-Api-Key: <api-key>' \
--data '
{
"offer_status": "active",
"redirect_mode": "standard",
"conversion_method": "server_postback",
"session_definition": "cookie",
"network_advertiser_id": 13,
"name": "My CPA Offer",
"network_category_id": 1,
"destination_url": "https://example.com/offer?tid={transaction_id}",
"currency_id": "USD",
"network_tracking_domain_id": 1,
"visibility": "public",
"payout_revenue": [
{
"payout_type": "cpa",
"payout_amount": 2.5,
"revenue_type": "rpa",
"revenue_amount": 4,
"is_default": true
}
]
}
'import requests
url = "https://api.eflow.team/v1/networks/offers"
payload = {
"offer_status": "active",
"redirect_mode": "standard",
"conversion_method": "server_postback",
"session_definition": "cookie",
"network_advertiser_id": 13,
"name": "My CPA Offer",
"network_category_id": 1,
"destination_url": "https://example.com/offer?tid={transaction_id}",
"currency_id": "USD",
"network_tracking_domain_id": 1,
"visibility": "public",
"payout_revenue": [
{
"payout_type": "cpa",
"payout_amount": 2.5,
"revenue_type": "rpa",
"revenue_amount": 4,
"is_default": True
}
]
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offer_status: 'active',
redirect_mode: 'standard',
conversion_method: 'server_postback',
session_definition: 'cookie',
network_advertiser_id: 13,
name: 'My CPA Offer',
network_category_id: 1,
destination_url: 'https://example.com/offer?tid={transaction_id}',
currency_id: 'USD',
network_tracking_domain_id: 1,
visibility: 'public',
payout_revenue: [
{
payout_type: 'cpa',
payout_amount: 2.5,
revenue_type: 'rpa',
revenue_amount: 4,
is_default: true
}
]
})
};
fetch('https://api.eflow.team/v1/networks/offers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/networks/offers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'offer_status' => 'active',
'redirect_mode' => 'standard',
'conversion_method' => 'server_postback',
'session_definition' => 'cookie',
'network_advertiser_id' => 13,
'name' => 'My CPA Offer',
'network_category_id' => 1,
'destination_url' => 'https://example.com/offer?tid={transaction_id}',
'currency_id' => 'USD',
'network_tracking_domain_id' => 1,
'visibility' => 'public',
'payout_revenue' => [
[
'payout_type' => 'cpa',
'payout_amount' => 2.5,
'revenue_type' => 'rpa',
'revenue_amount' => 4,
'is_default' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/offers"
payload := strings.NewReader("{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/networks/offers")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/offers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"network_offer_id": 123,
"network_id": 123,
"network_advertiser_id": 123,
"network_offer_group_id": 123,
"name": "<string>",
"offer_status": "active",
"thumbnail_url": "<string>",
"visibility": "public",
"currency_id": "<string>",
"destination_url": "<string>",
"server_side_url": "<string>",
"preview_url": "<string>",
"html_description": "<string>",
"internal_notes": "<string>",
"network_category_id": 123,
"project_id": "<string>",
"date_live_until": "<string>",
"conversion_method": "server_postback",
"redirect_mode": "standard",
"redirect_routing_method": "internal",
"session_definition": "cookie",
"session_duration": 123,
"attribution_method": "first_touch",
"is_caps_enabled": true,
"daily_conversion_cap": 123,
"weekly_conversion_cap": 123,
"monthly_conversion_cap": 123,
"global_conversion_cap": 123,
"daily_payout_cap": 123,
"weekly_payout_cap": 123,
"monthly_payout_cap": 123,
"global_payout_cap": 123,
"daily_revenue_cap": 123,
"weekly_revenue_cap": 123,
"monthly_revenue_cap": 123,
"global_revenue_cap": 123,
"daily_click_cap": 123,
"weekly_click_cap": 123,
"monthly_click_cap": 123,
"global_click_cap": 123,
"is_use_scrub_rate": true,
"scrub_rate_percentage": 123,
"is_duplicate_filter_enabled": true,
"is_block_already_converted": true,
"is_use_secure_link": true,
"is_allow_deep_link": true,
"is_session_tracking_enabled": true,
"is_whitelist_check_enabled": true,
"network_tracking_domain_id": 123,
"caps_timezone_id": 123,
"app_identifier": "<string>",
"labels": [
"<string>"
],
"is_seo_friendly": true,
"is_use_direct_linking": true,
"is_view_through_enabled": true,
"view_through_destination_url": "<string>",
"session_tracking_lifespan_hour": 123,
"session_tracking_minimum_lifespan_second": 123,
"is_fail_traffic_enabled": true,
"redirect_internal_routing_type": "priority",
"is_using_suppression_list": true,
"suppression_list_id": 123,
"is_using_explicit_terms_and_conditions": true,
"terms_and_conditions": "<string>",
"is_force_terms_and_conditions": true,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"duplicate_filter_targeting_action": "unknown",
"already_converted_action": "unknown",
"scrub_rate_status": "rejected",
"is_description_plain_text": true,
"is_email_attribution_enabled": true,
"email_attribution_method": "unknown",
"is_email_attribution_window_enabled": true,
"email_attribution_window_minute": 123,
"email_attribution_window_type": "unknown",
"is_view_through_session_tracking_enabled": true,
"view_through_session_tracking_lifespan_minute": 123,
"view_through_session_tracking_minimal_lifespan_second": 123,
"session_tracking_start_on": "<string>",
"encoded_value": "<string>",
"payout_revenue": [
{
"network_offer_payout_revenue_id": 123,
"entry_name": "<string>",
"payout_type": "cpa",
"payout_amount": 123,
"payout_percentage": 123,
"revenue_type": "rpa",
"revenue_amount": 123,
"revenue_percentage": 123,
"is_default": true,
"is_private": true,
"is_postback_disabled": true,
"is_enforce_caps": true,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"is_email_attribution_default_event": true,
"remote_offer_resource": {
"network_offer_id": 123,
"network_id": 123,
"resource_type": "<string>",
"remote_resource_id": "<string>",
"resource_id": 123,
"last_value_md5": "<string>",
"json_config": "<string>",
"json_data": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
}
}
],
"is_soft_cap": true,
"time_created": 1734455015,
"time_saved": 1734455015,
"relationship": {
"advertiser": {
"network_advertiser_id": 123,
"network_id": 123,
"name": "<string>",
"account_status": "<string>",
"network_employee_id": 123,
"internal_notes": "<string>",
"address_id": 123,
"is_contact_address_enabled": true,
"sales_manager_id": 123,
"is_expose_publisher_reporting_data": true,
"default_currency_id": "<string>",
"platform_name": "<string>",
"platform_url": "<string>",
"platform_username": "<string>",
"reporting_timezone_id": 123,
"accounting_contact_email": "<string>",
"verification_token": "<string>",
"offer_id_macro": "<string>",
"affiliate_id_macro": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015,
"attribution_method": "<string>",
"email_attribution_method": "<string>",
"attribution_priority": "<string>"
},
"category": {
"network_category_id": 123,
"network_id": 123,
"name": "<string>",
"status": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
},
"creatives": {
"total": 123,
"entries": [
{}
]
},
"traffic_filters": {
"total": 123,
"entries": [
{}
]
},
"labels": {
"total": 123,
"entries": [
{}
]
},
"payout_revenue": {
"total": 123,
"entries": [
{
"network_offer_payout_revenue_id": 123,
"network_id": 123,
"network_offer_id": 123,
"entry_name": "<string>",
"payout_type": "<string>",
"payout_amount": 123,
"payout_percentage": 123,
"revenue_type": "<string>",
"revenue_amount": 123,
"revenue_percentage": 123,
"is_default": true,
"is_private": true,
"is_postback_disabled": true,
"is_enforce_caps": true,
"time_created": 1734455015,
"global_advertiser_event_id": 123,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"is_email_attribution_default_event": true,
"remote_offer_resource": {
"network_offer_id": 123,
"network_id": 123,
"resource_type": "<string>",
"remote_resource_id": "<string>",
"resource_id": 123,
"last_value_md5": "<string>",
"json_config": "<string>",
"json_data": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
}
}
]
},
"custom_cap_settings": {
"total": 123,
"entries": [
{}
]
},
"custom_scrub_rate_settings": {
"total": 123,
"entries": [
{}
]
},
"custom_payout_revenue_settings": {
"total": 123,
"entries": [
{}
]
},
"reporting": {
"imp": 123,
"total_click": 123,
"unique_click": 123,
"invalid_click": 123,
"duplicate_click": 123,
"gross_click": 123,
"ctr": 123,
"cv": 123,
"invalid_cv_scrub": 123,
"view_through_cv": 123,
"total_cv": 123,
"event": 123,
"cvr": 123,
"evr": 123,
"cpc": 123,
"cpm": 123,
"cpa": 123,
"epc": 123,
"rpc": 123,
"rpa": 123,
"rpm": 123,
"payout": 123,
"revenue": 123,
"event_revenue": 123,
"gross_sales": 123,
"profit": 123,
"margin": 123,
"roas": 123,
"avg_sale_value": 123,
"media_buying_cost": 123,
"on_hold_potential_revenue": 123,
"on_hold_potential_payout": 123,
"on_hold_conversion_count": 123,
"public_events": 123
},
"audits": {
"total": 123,
"entries": [
{}
]
},
"visibility": {
"network_id": 123,
"network_offer_id": 123,
"network_affiliate_visible_ids": [
123
],
"network_affiliate_rejected_ids": [
123
],
"network_affiliate_hidden_ids": [
123
]
},
"integrations": {
"optizmo": {},
"twentyfour_metrics": {},
"offer_demand_partner": {},
"forensiq": {},
"ezepo": {},
"anura": {},
"invoca": {},
"ip_quality_score": {},
"unsubcentral": {},
"ringba": {},
"retreaver": {}
},
"ruleset": {
"network_id": 123,
"network_ruleset_id": 123,
"time_created": 1734455015,
"time_saved": 1734455015,
"platforms": [
{}
],
"device_types": [
{}
],
"os_versions": [
{}
],
"browsers": [
{}
],
"languages": [
{}
],
"countries": [
{}
],
"regions": [
{}
],
"cities": [
{}
],
"dmas": [
{}
],
"mobile_carriers": [
{}
],
"connection_types": [
{}
],
"ips": [
{}
],
"is_block_proxy": true,
"is_use_day_parting": true,
"day_parting_apply_to": "<string>",
"day_parting_timezone_id": 123,
"days_parting": [
{}
],
"isps": [
{}
],
"brands": [
{}
],
"postal_codes": [
{}
]
},
"source_names": {
"total": 123,
"entries": [
{}
]
},
"urls": {
"total": 123,
"entries": [
{}
]
},
"encoded_value": "<string>",
"remaining_caps": {
"remaining_daily_payout_cap": 123,
"remaining_daily_revenue_cap": 123,
"remaining_daily_conversion_cap": 123,
"remaining_daily_click_cap": 123,
"remaining_weekly_payout_cap": 123,
"remaining_weekly_revenue_cap": 123,
"remaining_weekly_conversion_cap": 123,
"remaining_weekly_click_cap": 123,
"remaining_monthly_payout_cap": 123,
"remaining_monthly_revenue_cap": 123,
"remaining_monthly_conversion_cap": 123,
"remaining_monthly_click_cap": 123,
"remaining_global_payout_cap": 123,
"remaining_global_revenue_cap": 123,
"remaining_global_conversion_cap": 123,
"remaining_global_click_cap": 123
},
"is_locked_currency": true,
"custom_creative_settings": {
"total": 123,
"entries": [
{}
]
},
"channels": {
"total": 123,
"entries": [
{}
]
},
"is_locked_caps_timezone": true,
"meta": {
"network_offer_id": 123,
"network_id": 123,
"app_id": "<string>",
"meta_platform": "<string>",
"advertiser_campaign_name": "<string>",
"bundle_id": "<string>",
"category": "<string>",
"store_url": "<string>",
"score_rating": 123,
"total_rating": 123,
"size": 123,
"developer": "<string>",
"version": "<string>",
"is_app_unavailable": true,
"time_created": 1734455015,
"time_app_data_saved": 1734455015,
"time_saved": 1734455015
},
"requirement_kpis": {
"total": 123,
"entries": [
{}
]
},
"requirement_tracking_parameters": {
"total": 123,
"entries": [
{}
]
}
}
}Create Offer
curl --request POST \
--url https://api.eflow.team/v1/networks/offers \
--header 'Content-Type: application/json' \
--header 'X-Eflow-Api-Key: <api-key>' \
--data '
{
"offer_status": "active",
"redirect_mode": "standard",
"conversion_method": "server_postback",
"session_definition": "cookie",
"network_advertiser_id": 13,
"name": "My CPA Offer",
"network_category_id": 1,
"destination_url": "https://example.com/offer?tid={transaction_id}",
"currency_id": "USD",
"network_tracking_domain_id": 1,
"visibility": "public",
"payout_revenue": [
{
"payout_type": "cpa",
"payout_amount": 2.5,
"revenue_type": "rpa",
"revenue_amount": 4,
"is_default": true
}
]
}
'import requests
url = "https://api.eflow.team/v1/networks/offers"
payload = {
"offer_status": "active",
"redirect_mode": "standard",
"conversion_method": "server_postback",
"session_definition": "cookie",
"network_advertiser_id": 13,
"name": "My CPA Offer",
"network_category_id": 1,
"destination_url": "https://example.com/offer?tid={transaction_id}",
"currency_id": "USD",
"network_tracking_domain_id": 1,
"visibility": "public",
"payout_revenue": [
{
"payout_type": "cpa",
"payout_amount": 2.5,
"revenue_type": "rpa",
"revenue_amount": 4,
"is_default": True
}
]
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
offer_status: 'active',
redirect_mode: 'standard',
conversion_method: 'server_postback',
session_definition: 'cookie',
network_advertiser_id: 13,
name: 'My CPA Offer',
network_category_id: 1,
destination_url: 'https://example.com/offer?tid={transaction_id}',
currency_id: 'USD',
network_tracking_domain_id: 1,
visibility: 'public',
payout_revenue: [
{
payout_type: 'cpa',
payout_amount: 2.5,
revenue_type: 'rpa',
revenue_amount: 4,
is_default: true
}
]
})
};
fetch('https://api.eflow.team/v1/networks/offers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/networks/offers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'offer_status' => 'active',
'redirect_mode' => 'standard',
'conversion_method' => 'server_postback',
'session_definition' => 'cookie',
'network_advertiser_id' => 13,
'name' => 'My CPA Offer',
'network_category_id' => 1,
'destination_url' => 'https://example.com/offer?tid={transaction_id}',
'currency_id' => 'USD',
'network_tracking_domain_id' => 1,
'visibility' => 'public',
'payout_revenue' => [
[
'payout_type' => 'cpa',
'payout_amount' => 2.5,
'revenue_type' => 'rpa',
'revenue_amount' => 4,
'is_default' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eflow.team/v1/networks/offers"
payload := strings.NewReader("{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/networks/offers")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eflow.team/v1/networks/offers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"offer_status\": \"active\",\n \"redirect_mode\": \"standard\",\n \"conversion_method\": \"server_postback\",\n \"session_definition\": \"cookie\",\n \"network_advertiser_id\": 13,\n \"name\": \"My CPA Offer\",\n \"network_category_id\": 1,\n \"destination_url\": \"https://example.com/offer?tid={transaction_id}\",\n \"currency_id\": \"USD\",\n \"network_tracking_domain_id\": 1,\n \"visibility\": \"public\",\n \"payout_revenue\": [\n {\n \"payout_type\": \"cpa\",\n \"payout_amount\": 2.5,\n \"revenue_type\": \"rpa\",\n \"revenue_amount\": 4,\n \"is_default\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"network_offer_id": 123,
"network_id": 123,
"network_advertiser_id": 123,
"network_offer_group_id": 123,
"name": "<string>",
"offer_status": "active",
"thumbnail_url": "<string>",
"visibility": "public",
"currency_id": "<string>",
"destination_url": "<string>",
"server_side_url": "<string>",
"preview_url": "<string>",
"html_description": "<string>",
"internal_notes": "<string>",
"network_category_id": 123,
"project_id": "<string>",
"date_live_until": "<string>",
"conversion_method": "server_postback",
"redirect_mode": "standard",
"redirect_routing_method": "internal",
"session_definition": "cookie",
"session_duration": 123,
"attribution_method": "first_touch",
"is_caps_enabled": true,
"daily_conversion_cap": 123,
"weekly_conversion_cap": 123,
"monthly_conversion_cap": 123,
"global_conversion_cap": 123,
"daily_payout_cap": 123,
"weekly_payout_cap": 123,
"monthly_payout_cap": 123,
"global_payout_cap": 123,
"daily_revenue_cap": 123,
"weekly_revenue_cap": 123,
"monthly_revenue_cap": 123,
"global_revenue_cap": 123,
"daily_click_cap": 123,
"weekly_click_cap": 123,
"monthly_click_cap": 123,
"global_click_cap": 123,
"is_use_scrub_rate": true,
"scrub_rate_percentage": 123,
"is_duplicate_filter_enabled": true,
"is_block_already_converted": true,
"is_use_secure_link": true,
"is_allow_deep_link": true,
"is_session_tracking_enabled": true,
"is_whitelist_check_enabled": true,
"network_tracking_domain_id": 123,
"caps_timezone_id": 123,
"app_identifier": "<string>",
"labels": [
"<string>"
],
"is_seo_friendly": true,
"is_use_direct_linking": true,
"is_view_through_enabled": true,
"view_through_destination_url": "<string>",
"session_tracking_lifespan_hour": 123,
"session_tracking_minimum_lifespan_second": 123,
"is_fail_traffic_enabled": true,
"redirect_internal_routing_type": "priority",
"is_using_suppression_list": true,
"suppression_list_id": 123,
"is_using_explicit_terms_and_conditions": true,
"terms_and_conditions": "<string>",
"is_force_terms_and_conditions": true,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"duplicate_filter_targeting_action": "unknown",
"already_converted_action": "unknown",
"scrub_rate_status": "rejected",
"is_description_plain_text": true,
"is_email_attribution_enabled": true,
"email_attribution_method": "unknown",
"is_email_attribution_window_enabled": true,
"email_attribution_window_minute": 123,
"email_attribution_window_type": "unknown",
"is_view_through_session_tracking_enabled": true,
"view_through_session_tracking_lifespan_minute": 123,
"view_through_session_tracking_minimal_lifespan_second": 123,
"session_tracking_start_on": "<string>",
"encoded_value": "<string>",
"payout_revenue": [
{
"network_offer_payout_revenue_id": 123,
"entry_name": "<string>",
"payout_type": "cpa",
"payout_amount": 123,
"payout_percentage": 123,
"revenue_type": "rpa",
"revenue_amount": 123,
"revenue_percentage": 123,
"is_default": true,
"is_private": true,
"is_postback_disabled": true,
"is_enforce_caps": true,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"is_email_attribution_default_event": true,
"remote_offer_resource": {
"network_offer_id": 123,
"network_id": 123,
"resource_type": "<string>",
"remote_resource_id": "<string>",
"resource_id": 123,
"last_value_md5": "<string>",
"json_config": "<string>",
"json_data": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
}
}
],
"is_soft_cap": true,
"time_created": 1734455015,
"time_saved": 1734455015,
"relationship": {
"advertiser": {
"network_advertiser_id": 123,
"network_id": 123,
"name": "<string>",
"account_status": "<string>",
"network_employee_id": 123,
"internal_notes": "<string>",
"address_id": 123,
"is_contact_address_enabled": true,
"sales_manager_id": 123,
"is_expose_publisher_reporting_data": true,
"default_currency_id": "<string>",
"platform_name": "<string>",
"platform_url": "<string>",
"platform_username": "<string>",
"reporting_timezone_id": 123,
"accounting_contact_email": "<string>",
"verification_token": "<string>",
"offer_id_macro": "<string>",
"affiliate_id_macro": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015,
"attribution_method": "<string>",
"email_attribution_method": "<string>",
"attribution_priority": "<string>"
},
"category": {
"network_category_id": 123,
"network_id": 123,
"name": "<string>",
"status": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
},
"creatives": {
"total": 123,
"entries": [
{}
]
},
"traffic_filters": {
"total": 123,
"entries": [
{}
]
},
"labels": {
"total": 123,
"entries": [
{}
]
},
"payout_revenue": {
"total": 123,
"entries": [
{
"network_offer_payout_revenue_id": 123,
"network_id": 123,
"network_offer_id": 123,
"entry_name": "<string>",
"payout_type": "<string>",
"payout_amount": 123,
"payout_percentage": 123,
"revenue_type": "<string>",
"revenue_amount": 123,
"revenue_percentage": 123,
"is_default": true,
"is_private": true,
"is_postback_disabled": true,
"is_enforce_caps": true,
"time_created": 1734455015,
"global_advertiser_event_id": 123,
"is_must_approve_conversion": true,
"is_allow_duplicate_conversion": true,
"is_email_attribution_default_event": true,
"remote_offer_resource": {
"network_offer_id": 123,
"network_id": 123,
"resource_type": "<string>",
"remote_resource_id": "<string>",
"resource_id": 123,
"last_value_md5": "<string>",
"json_config": "<string>",
"json_data": "<string>",
"time_created": 1734455015,
"time_saved": 1734455015
}
}
]
},
"custom_cap_settings": {
"total": 123,
"entries": [
{}
]
},
"custom_scrub_rate_settings": {
"total": 123,
"entries": [
{}
]
},
"custom_payout_revenue_settings": {
"total": 123,
"entries": [
{}
]
},
"reporting": {
"imp": 123,
"total_click": 123,
"unique_click": 123,
"invalid_click": 123,
"duplicate_click": 123,
"gross_click": 123,
"ctr": 123,
"cv": 123,
"invalid_cv_scrub": 123,
"view_through_cv": 123,
"total_cv": 123,
"event": 123,
"cvr": 123,
"evr": 123,
"cpc": 123,
"cpm": 123,
"cpa": 123,
"epc": 123,
"rpc": 123,
"rpa": 123,
"rpm": 123,
"payout": 123,
"revenue": 123,
"event_revenue": 123,
"gross_sales": 123,
"profit": 123,
"margin": 123,
"roas": 123,
"avg_sale_value": 123,
"media_buying_cost": 123,
"on_hold_potential_revenue": 123,
"on_hold_potential_payout": 123,
"on_hold_conversion_count": 123,
"public_events": 123
},
"audits": {
"total": 123,
"entries": [
{}
]
},
"visibility": {
"network_id": 123,
"network_offer_id": 123,
"network_affiliate_visible_ids": [
123
],
"network_affiliate_rejected_ids": [
123
],
"network_affiliate_hidden_ids": [
123
]
},
"integrations": {
"optizmo": {},
"twentyfour_metrics": {},
"offer_demand_partner": {},
"forensiq": {},
"ezepo": {},
"anura": {},
"invoca": {},
"ip_quality_score": {},
"unsubcentral": {},
"ringba": {},
"retreaver": {}
},
"ruleset": {
"network_id": 123,
"network_ruleset_id": 123,
"time_created": 1734455015,
"time_saved": 1734455015,
"platforms": [
{}
],
"device_types": [
{}
],
"os_versions": [
{}
],
"browsers": [
{}
],
"languages": [
{}
],
"countries": [
{}
],
"regions": [
{}
],
"cities": [
{}
],
"dmas": [
{}
],
"mobile_carriers": [
{}
],
"connection_types": [
{}
],
"ips": [
{}
],
"is_block_proxy": true,
"is_use_day_parting": true,
"day_parting_apply_to": "<string>",
"day_parting_timezone_id": 123,
"days_parting": [
{}
],
"isps": [
{}
],
"brands": [
{}
],
"postal_codes": [
{}
]
},
"source_names": {
"total": 123,
"entries": [
{}
]
},
"urls": {
"total": 123,
"entries": [
{}
]
},
"encoded_value": "<string>",
"remaining_caps": {
"remaining_daily_payout_cap": 123,
"remaining_daily_revenue_cap": 123,
"remaining_daily_conversion_cap": 123,
"remaining_daily_click_cap": 123,
"remaining_weekly_payout_cap": 123,
"remaining_weekly_revenue_cap": 123,
"remaining_weekly_conversion_cap": 123,
"remaining_weekly_click_cap": 123,
"remaining_monthly_payout_cap": 123,
"remaining_monthly_revenue_cap": 123,
"remaining_monthly_conversion_cap": 123,
"remaining_monthly_click_cap": 123,
"remaining_global_payout_cap": 123,
"remaining_global_revenue_cap": 123,
"remaining_global_conversion_cap": 123,
"remaining_global_click_cap": 123
},
"is_locked_currency": true,
"custom_creative_settings": {
"total": 123,
"entries": [
{}
]
},
"channels": {
"total": 123,
"entries": [
{}
]
},
"is_locked_caps_timezone": true,
"meta": {
"network_offer_id": 123,
"network_id": 123,
"app_id": "<string>",
"meta_platform": "<string>",
"advertiser_campaign_name": "<string>",
"bundle_id": "<string>",
"category": "<string>",
"store_url": "<string>",
"score_rating": 123,
"total_rating": 123,
"size": 123,
"developer": "<string>",
"version": "<string>",
"is_app_unavailable": true,
"time_created": 1734455015,
"time_app_data_saved": 1734455015,
"time_saved": 1734455015
},
"requirement_kpis": {
"total": 123,
"entries": [
{}
]
},
"requirement_tracking_parameters": {
"total": 123,
"entries": [
{}
]
}
}
}Authorizations
The Everflow API key generated from the Control Center > Security.
Body
ID of the advertiser submitting the offer.
Offer name.
URL of the final landing page associated with the offer, including additional macros if applicable.
Currency used to compute payouts, costs, and revenues of the offer. Must be a currency_id returned by the List Currencies endpoint (ISO 4217 code, uppercase) - any other value is rejected with Unsupported currency ID.
On update, the currency cannot be changed once the offer has recorded traffic in the last 30 days; doing so is rejected with Could not change currency value on locked offer.
Category ID.
Offer status.
active, paused, pending, deleted Visibility setting for affiliates. Can be public, require_approval, or private.
public, require_approval, private ID of the tracking domain hit by clicks belonging to the offer.
Method used by the advertiser to fire tracking data to Everflow. The five legacy values (http_image_pixel, https_image_pixel, cookie_based, http_iframe_pixel, https_iframe_pixel) are accepted but silently normalized to html_pixel_cookie_based, so responses only ever return server_postback, javascript or html_pixel_cookie_based.
server_postback, javascript, html_pixel_cookie_based, http_image_pixel, https_image_pixel, http_iframe_pixel, https_iframe_pixel, cookie_based Setting used to obscure referrer URLs from advertisers. Non-standard modes (single_meta_refresh, double_meta_refresh) are not recommended as they cause click drop-off.
standard, single_meta_refresh, double_meta_refresh, seo_friendly Method used for determining whether a click is unique.
cookie, ip, ip_user_agent, google_ad_id, idfa Duration (in hours) of the active session used to match a click to a conversion. Defaults to 24.
Whether tracking links use https:// instead of http://. Validate with your account manager that SSL is enabled before using.
Whether affiliates can send their traffic to target URLs by adding &url=[target URL] to their tracking links, instead of the offer's destination URL.
Whether caps are enabled. When false, voids all types of caps and custom caps.
Whether duplicate clicks are filtered and acted upon, according to duplicate_filter_targeting_action.
Action to take when a duplicate click is detected. Required and validated when is_duplicate_filter_enabled is true - an invalid value is rejected. Ignored when false; the API then returns unknown for this field, which cannot be submitted here.
block, fail_traffic Whether conversions must be manually approved before being finalized.
Whether duplicate conversions are allowed.
Whether conversions can be generated from impressions (as opposed to clicks only).
Whether affiliate's conversions and payouts get automatically blocked based on a minimum and maximum time from the click to the associated conversion.
Whether invalid clicks will be redirected to another offer.
Redirect mechanism that determines how fail traffic is distributed between listed offers. Can be priority, weight, priority_global, or weight_global. Only relevant when is_fail_traffic_enabled is true. The API returns null_value when this hasn't been configured; that value cannot be submitted here.
priority, weight, priority_global, weight_global Whether an email suppression list is used for this offer.
Whether the offer uses specific Terms and Conditions. When false, defaults to the network's general Terms and Conditions.
Whether affiliates are required to accept the offer's specific Terms and Conditions.
Show child attributes
Show child attributes
Associated offer group.
URL of the image thumbnail associated with the offer, visible to network employees and affiliates.
Notes on the offer for network employees. Not displayed to affiliates and advertisers.
Server-side URL that will be asynchronously fired by Everflow following a click.
Landing page preview URL.
Description of the offer for the affiliates. HTML code is accepted.
Whether the description of the offer should be interpreted as plain text (true) or HTML (false).
ID for the advertiser campaign or an Insertion Order.
Date until when the offer can be run. Events occurring past the end of the day at the timezone of the network will be rejected. Format: YYYY-MM-DD.
Bundle ID for iOS / Android apps.
Labels used for organizing offers by private internal keywords.
ID of the timezone used for the caps if it differs from the network's default.
Only internal is accepted. The API returns null_value when no internal routing is configured for the offer - that value cannot be submitted here.
internal Attribution model for the offer. first_touch can only be used when conversion_method is javascript or html_pixel_cookie_based; the request is rejected otherwise.
first_touch, last_touch Whether soft caps are enabled for this offer.
Whether a check is made to ensure conversion postbacks originate from the advertiser.
Whether Direct Linking is enabled for this offer.
Maximum number of unique conversions per day.
Maximum conversions per week (Monday midnight to Sunday 23:59:59).
Maximum conversions per month.
Maximum total conversions for this offer.
Whether clicks from users who have already converted on this offer are acted upon per already_converted_action.
Action to take for clicks from already-converted users. Required and validated when is_block_already_converted is true - an invalid value is rejected. Ignored when false; the API then returns unknown for this field, which cannot be submitted here.
block, fail_traffic Whether a predefined percentage of conversions get automatically throttled (scrubbed). Only relevant if is_must_approve_conversion is true. This mechanism prevents an excessive number of conversions from being approved.
Status to apply to conversions affected by throttling. Required and validated when is_use_scrub_rate is true - an invalid value is rejected with Invalid scrub rate status. Ignored when false; the API then returns null_value for this field, which cannot be submitted here.
rejected, pending Percentage of conversions to automatically throttle. Only relevant if is_use_scrub_rate is true.
URL of the final landing page when redirected from an impression, including additional macros if applicable. Only relevant if is_view_through_enabled is true.
Maximum hours between click and valid conversion. Required if is_session_tracking_enabled is true.
Minimum seconds between click and valid conversion. Required if is_session_tracking_enabled is true.
ID of the suppression list associated with the offer. Only relevant if is_using_suppression_list is true.
Whether affiliate's conversions and payouts get automatically blocked based on a minimum and maximum time from the impression to the associated conversion. Only relevant if is_view_through_enabled is true.
Maximum interval of time (in minutes) between the impression event and a valid conversion or event. Required only if is_view_through_session_tracking_enabled is true.
Minimum seconds between impression and valid conversion. Only relevant if is_view_through_session_tracking_enabled is true.
Whether email attribution is enabled for this offer.
Method used for email attribution. Not required to enable email attribution (see is_email_attribution_enabled); when unset, the API returns unknown for this field, which cannot be submitted here.
first_affiliate_attribution, last_affiliate_attribution Whether the email attribution window is enabled.
Duration (in minutes) of the email attribution window.
Type of email attribution window. When unset, the API returns unknown for this field, which cannot be submitted here.
static, dynamic Text listing the specific Terms and Conditions of the offer. Required only if is_using_explicit_terms_and_conditions is true.
Email compliance settings (approved subject and from lines).
Show child attributes
Show child attributes
Email opt-out settings (suppression file and unsubscribe link).
Show child attributes
Show child attributes
Pre-approved source names for this offer.
Offer thumbnail image. Upload the file first via the Upload Temp File endpoint, then pass the temp_url and original_file_name here.
Show child attributes
Show child attributes
Email suppression list file. Only relevant when is_using_suppression_list is true. Upload the file first via the Upload Temp File endpoint, then pass the temp_url and original_file_name here. Write-only - it is never returned.
Show child attributes
Show child attributes
Assign the offer to an existing application questionnaire. Only relevant when visibility is require_approval. The request is rejected if the questionnaire does not exist. Write-only - on read it is returned under relationship.network_application_questionnaire_id.
Metadata fields for the offer.
Show child attributes
Show child attributes
Channels this offer belongs to.
Show child attributes
Show child attributes
Third-party integration settings. Each integration has its own configuration object.
Show child attributes
Show child attributes
Targeting ruleset for this offer. Contains nested arrays for geographic, device, browser, and connection-type targeting. Each targeting entry includes an ID, targeting_type (include or exclude), and match_type. Sub-objects include: platforms, device_types, os_versions, brands, browsers, languages, countries, regions, cities, dmas, mobile_carriers, isps, connection_types, ips, postal_codes. Also supports day parting via is_use_day_parting, day_parting_apply_to, day_parting_timezone_id, and days_parting array.
Traffic control filters for this offer. Each filter specifies a URL parameter to match against.
Show child attributes
Show child attributes
Fail traffic redirect configuration. Determines where invalid clicks are sent when is_fail_traffic_enabled is true.
Show child attributes
Show child attributes
Creatives to create alongside the offer. Each creative requires a name, type, and type-specific fields. This allows creating an offer and its creatives in a single API call.
Show child attributes
Show child attributes
KPI requirements for this offer.
Show child attributes
Show child attributes
Required tracking parameters for this offer.
Show child attributes
Show child attributes
Response
Unique offer ID.
Advertiser that owns this offer.
Offer group ID.
Offer name.
active, paused, pending, deleted public, require_approval, private Destination URL for the offer.
Server-side postback URL.
HTML description of the offer.
Internal notes (not visible to affiliates).
Offer expiration date (YYYY-MM-DD).
server_postback, http_image_pixel, https_image_pixel, http_iframe_pixel, https_iframe_pixel, javascript, cookie_based, html_pixel_cookie_based Setting used to obscure referrer URLs from advertisers. Non-standard modes (single_meta_refresh, double_meta_refresh) are not recommended as they cause click drop-off.
standard, single_meta_refresh, double_meta_refresh, seo_friendly null_value means no internal routing is configured; not a valid value on create/update.
internal, null_value Method used for determining whether a click is unique.
cookie, ip, ip_user_agent, google_ad_id, idfa Session duration in hours.
first_touch, last_touch null_value means fail-traffic routing isn't configured; not a valid value on create/update.
priority, weight, priority_global, weight_global, null_value unknown means no duplicate-filter action is configured; not a valid value on create/update.
unknown, block, fail_traffic unknown means no already-converted action is configured; not a valid value on create/update.
unknown, block, fail_traffic null_value means scrubbing isn't configured; not a valid value on create/update.
rejected, pending, null_value unknown means no email attribution method is set; not a valid value on create/update.
unknown, first_affiliate_attribution, last_affiliate_attribution unknown means no email attribution window type is set; not a valid value on create/update.
unknown, static, dynamic Maximum minutes between impression and valid conversion.
Minimum seconds between impression and valid conversion.
Encoded offer ID for use in tracking links.
Show child attributes
Show child attributes
Whether soft caps are enabled for this offer.
Unix timestamp of creation.
1734455015
Unix timestamp of last update.
1734455015
Related data returned with the offer.
Show child attributes
Show child attributes
Was this page helpful?