### Fetch All Deals with Offer ID Filters (cURL) Source: https://developers.everflow.io/docs/affiliate/deals This example shows how to fetch all available deals, with an option to filter by a list of offer IDs. It uses a GET request to the /v1/affiliates/deals endpoint and requires an API key. The request body can include a 'filters' object with 'network_offer_ids'. ```cURL curl --request GET 'https://api.eflow.team/v1/affiliates/deals' \ --header 'X-Eflow-API-Key: ' \ --header 'content-type: application/json' ``` -------------------------------- ### Get Offer Deal by ID (cURL) Source: https://developers.everflow.io/docs/affiliate/deals Example of how to retrieve a specific offer deal using cURL. This request includes optional relationships like locations, resources, and trackings. Ensure you replace placeholders with your actual API key and IDs. ```bash curl --request GET 'https://api.eflow.team/v1/offers//deals/?relationship=locations&relationship=resources&relationship=trackings' \ --header 'X-Eflow-API-Key: ' \ --header 'content-type: application/json' ``` -------------------------------- ### Example: Find Applications by Partner IDs (JSON Body) Source: https://developers.everflow.io/docs/network/offer_applications An example JSON payload to find all applications associated with specific partner (affiliate) IDs. ```JSON { "filters": { "network_affiliate_ids": [1, 2] } } ``` -------------------------------- ### Copy Offer with Default Parameters (URL) Source: https://developers.everflow.io/docs/network/offers This URL example illustrates the default behavior when copying an offer. If query string parameters are omitted, they default to false. This example explicitly shows the default values for clarity. ```url https://api.eflow.team/v1/networks/offers/151/copy?is_copy_custom_settings=true&is_copy_visibility=true&is_copy_additional_urls=false&is_copy_forwarding_rules=false&is_copy_creatives=false ``` -------------------------------- ### Get All Product Feeds - Filter Example (JSON) Source: https://developers.everflow.io/docs/affiliate/product_feed An example JSON payload for the 'Get All Product Feeds' endpoint, demonstrating how to filter product feeds by a list of offer IDs. ```json { "filters": { "network_offer_ids": [1, 2] } } ``` -------------------------------- ### cURL Request Example for Affiliate Signup Source: https://developers.everflow.io/docs/network/signup This snippet demonstrates how to make a POST request to the Everflow API's affiliate signup endpoint using cURL. It includes placeholders for the API key and the request payload, which should contain the affiliate's details. ```bash curl --request POST 'https://api.eflow.team/v1/networks/affiliate/signup' \ --header 'X-Eflow-API-Key: ' \ --data '' ``` -------------------------------- ### Get Conversion by ID - cURL Example Source: https://developers.everflow.io/docs/advertiser/reporting This example shows how to retrieve a specific conversion's details using its unique ID via a GET request with cURL. It requires an API key for authentication and the conversion ID in the URL path. The response is a JSON object containing all conversion-related information. ```bash curl --request GET 'https://api.eflow.team/v1/advertisers/reporting/conversions/' \ --header 'X-Eflow-API-Key: ' ``` -------------------------------- ### Find All DMAs - cURL Request Example Source: https://developers.everflow.io/docs/metadata/dmas This cURL example demonstrates how to make a GET request to the `/v1/meta/dmas` endpoint to retrieve all available Designated Market Areas. It requires an API key for authentication. ```bash curl --request GET 'https://api.eflow.team/v1/meta/dmas' \ --header 'X-Eflow-API-Key: ' ``` -------------------------------- ### Advertiser Signup API Request (cURL) Source: https://developers.everflow.io/docs/network/signup A cURL command to demonstrate how to make a POST request to the advertiser signup endpoint. Requires an API key and the request payload. ```bash curl --request POST 'https://api.eflow.team/v1/networks/advertiser/signup' \ --header 'X-Eflow-API-Key: ' --data '' ``` -------------------------------- ### Get Partner Invoice by ID (cURL) Source: https://developers.everflow.io/docs/network/invoices This cURL example demonstrates how to fetch the details of a specific partner invoice using its ID. The request is a GET request to the specified endpoint, requiring an API key in the headers. ```shell curl --request GET '/v1/networks/billings/affiliates/invoices/553' \ --header 'X-Eflow-API-Key: ' ``` -------------------------------- ### Affiliate Postback Filter Example (JSON) Source: https://developers.everflow.io/docs/network/reporting/affiliate_postback Illustrates how to construct a JSON query for filtering affiliate postback data. This example shows how to apply multiple filters for the same resource type ('offer') using an OR logic, and different resource types using an AND logic. ```json { //... "query": { "filters":[ { "resource_type": "offer", "filter_id_value": "15" }, { "resource_type": "offer", "filter_id_value": "18" }, { "resource_type": "affiliate", "filter_id_value": "7" } ] } } ``` -------------------------------- ### Requesting a Single Relationship via URL Source: https://developers.everflow.io/docs/user-guide/relationships This example shows how to construct a GET request URL to fetch an affiliate by ID and include the 'users' relationship. ```http GET /v1/networks/affiliates/5?relationship=users ``` -------------------------------- ### Create Bulk Offer URLs (JSON Request Body Example) Source: https://developers.everflow.io/docs/network/offer_urls This JSON object demonstrates the structure for creating multiple offer URL settings simultaneously. It includes parameters for associating with offers, setting destination and preview URLs, defining affiliate applicability, and specifying affiliate IDs. ```json [ { "network_offer_id": 15, "name": "Offer Url A", "destination_url": "http://destination-url-a.com?tid={transaction_id}", "preview_url": "http://preview-url-a.com", "url_status": "active", "is_apply_specific_affiliates": false, "is_hidden_affiliate": false }, { "network_offer_id": 15, "name": "Offer Url B", "destination_url": "http://destination-url-b.com?tid={transaction_id}", "preview_url": "http://preview-url-b.com", "url_status": "active", "is_apply_specific_affiliates": true, "network_affiliate_ids": [ 7, 14 ], "is_hidden_affiliate": false }, { "network_offer_id": 16, "name": "Offer Url C", "destination_url": "http://destination-url-c.com?tid={transaction_id}", "preview_url": "http://preview-url-c.com", "url_status": "active", "is_apply_specific_affiliates": true, "network_affiliate_ids": [ 14 ], "is_hidden_affiliate": true } ] ``` -------------------------------- ### Get Affiliate Invoice Summary (cURL) Source: https://developers.everflow.io/docs/network/invoices This cURL example demonstrates how to retrieve a summary of affiliate invoices. It shows how to specify search terms like partner name and filter by date. The request body is sent as JSON. ```shell curl --request POST 'https://api.eflow.team/v1/networks/billings/affiliates/summary' \ --header 'X-Eflow-API-Key: ' \ --header 'Content-Type: application/json' \ --data '' ``` -------------------------------- ### Response Example for Bulk Offer URL Creation Source: https://developers.everflow.io/docs/network/offer_urls This JSON response shows the structure returned after a successful bulk offer URL creation request. It includes details for each created offer URL, such as its unique ID, associated network and offer IDs, and configuration parameters. ```json { "urls": [ { "network_offer_url_id": 6, "network_id": 1, "network_offer_id": 15, "name": "Offer Url A", "destination_url": "http://destination-url-a.com?tid={transaction_id}", "preview_url": "http://preview-url-a.com", "url_status": "active", "network_affiliate_ids": null, "is_apply_specific_affiliates": false, "is_hidden_affiliate": false, "time_created": 1614285696, "time_saved": 1614285696 }, { "network_offer_url_id": 7, "network_id": 1, "network_offer_id": 15, "name": "Offer Url B", "destination_url": "http://destination-url-b.com?tid={transaction_id}", "preview_url": "http://preview-url-b.com", "url_status": "active", "network_affiliate_ids": [ 7, 14 ], "is_apply_specific_affiliates": true, "is_hidden_affiliate": false, "time_created": 1614285696, "time_saved": 1614285696 }, { "network_offer_url_id": 8, "network_id": 1, "network_offer_id": 16, "name": "Offer Url C", "destination_url": "http://destination-url-c.com?tid={transaction_id}", "preview_url": "http://preview-url-c.com", "url_status": "active", "network_affiliate_ids": [ 14 ], "is_apply_specific_affiliates": true, "is_hidden_affiliate": true, "time_created": 1614285696, "time_saved": 1614285696 } ] } ``` -------------------------------- ### Copy Offer with Specific Parameters (URL) Source: https://developers.everflow.io/docs/network/offers This URL example shows how to copy an offer by specifying certain query string parameters to be true. Parameters not included will default to false, meaning their corresponding settings will not be copied. ```url https://api.eflow.team/v1/networks/offers/151/copy?is_copy_custom_settings=true&is_copy_visibility=true ``` -------------------------------- ### Find All Device Brands (cURL) Source: https://developers.everflow.io/docs/metadata/device_brands This cURL example demonstrates how to make a GET request to the /v1/meta/brands endpoint to retrieve a list of all supported device brands. It requires an API key for authentication and returns a JSON object containing an array of brand objects, each with a brand_id and name. ```shell curl --request GET 'https://api.eflow.team/v1/meta/brands' \ --header 'X-Eflow-API-Key: ' ``` -------------------------------- ### Basic Click Tracking with Everflow SDK Source: https://developers.everflow.io/docs/everflow-sdk/click_tracking This snippet demonstrates the most basic way to track a click using the Everflow SDK. It requires the offer_id and affiliate_id as mandatory parameters. This is the starting point for integrating Everflow click tracking. ```javascript EF.click({ offer_id: 1, // Required. The offer id affiliate_id: 1, //Required. The affiliate id }); ``` -------------------------------- ### Example Payload for Finding Payments Source: https://developers.everflow.io/docs/partner/earnings This JSON object represents an example payload for the 'Find All Payments' endpoint. It specifies a timezone, date range, and filters for payment types and status. This payload can be used with the cURL example. ```json { "timezone_id":80, "from":"2025-10-22", "to":"2025-11-21", "query":{ "search_terms":[], "filter":{ "partner_connection_ids":[], "payment_types":["pay"], "network_ids":[15], "payment_provider_payment_status": "paid" } } } ``` -------------------------------- ### Basic Advertiser Signup Request (JSON) Source: https://developers.everflow.io/docs/network/signup A fundamental JSON structure for initiating an advertiser signup. It includes essential contact and company information. ```json { "firstname": "John", "lastname": "Doe", "email": "john.doe@example.com", "phone": "555-555-1212", "legal_type": "individual", "company": "Example company", "website": "http://example-website.com", "advertise_method_description": "Facebook, Google Ads", "custom_terms": "", "platform_terms": "", "contact_address": { "address_1": "Address Line 1", "address_2": "Address Line 2", "city": "Example City", "zip_postal_code": "32789", "country_id": 227, "region_code": "FL" } } ``` -------------------------------- ### Generate Offer Tracking Link JSON Payload Source: https://developers.everflow.io/docs/network/tracking_links These examples show the JSON payload structure for generating offer tracking links. The first example includes only the required `network_affiliate_id` and `network_offer_id`. The second example demonstrates additional parameters like `sub1`, `sub3`, and `is_encrypt_parameters`. ```json { "network_affiliate_id": 7, "network_offer_id": 5 } ``` ```json { "network_affiliate_id": 3, "network_offer_id": 1, "sub1": "facebook", "sub3": "media_buying", "is_encrypt_parameters": true } ``` -------------------------------- ### Create Network Pixel Request Body Example (JSON) Source: https://developers.everflow.io/docs/network/postbacks This JSON object demonstrates the structure and example values for the request body when creating a network pixel. It includes essential fields like affiliate ID, delivery method, pixel level, status, type, and the postback URL. ```json { "network_id": 1, "network_affiliate_id": 7, "network_offer_id": 1, "network_offer_payout_revenue_id": 0, "delivery_method": "postback", "pixel_level": "global_offer", "pixel_status": "active", "pixel_type": "conversion", "postback_url": "http://test2.com?s2={sub2}&s1={sub1}", "html_code": "", "description": "Your postback" } ``` -------------------------------- ### JSON Request Body Example Source: https://developers.everflow.io/docs/user-guide/authentication An example of a JSON payload structure for submitting data to a resource via POST, PUT, or PATCH requests to the Everflow API. ```json { "property" : "value" } ``` -------------------------------- ### Fetch Affiliates with Filters (cURL) Source: https://developers.everflow.io/docs/network/affiliates This example demonstrates how to fetch a list of affiliates using the Everflow API. It shows how to specify filters such as account status and search terms, and includes parameters for pagination and including related data like users. ```cURL curl --request POST 'https://api.eflow.team/v1/networks/affiliatestable?page=2&page_size=50&relationship=users' \ --header 'X-Eflow-API-Key: ' \ --header 'Content-Type: application/json' \ --data '{ \ "filters": { \ "account_status": "active" \ }, \ "search_terms": [ \ { \ "search_type": "name", \ "value": "Agency" \ } \ ] \ }' ``` -------------------------------- ### POST /v1/networks/affiliate/signup Source: https://developers.everflow.io/docs/network/signup Creates a new affiliate user signup. The required fields for billing information depend on the selected payment type. ```APIDOC ## POST /v1/networks/affiliate/signup ### Description This endpoint allows for the creation of a new affiliate user account. The system dynamically determines required fields based on account settings and the chosen payment type for billing. ### Method POST ### Endpoint /v1/networks/affiliate/signup ### Parameters #### Query Parameters None #### Request Body - **firstname** (string) - Required - The first name of the affiliate user signing up. - **lastname** (string) - Required - The last name of the affiliate user signing up. - **email** (string) - Required - The email address of the user signing up. Must be unique. - **phone** (string) - Optional - Phone number. - **legal_type** (string) - Required - The affiliate’s entity legal type. Can be one of the following values: `individual`, `partnership`, `corporation`, `sole_proprietorship`, `other`, `foreign`, `llc`, `llp`, `non_profit`, `non_us_entity`. - **company** (string) - Optional - The affiliate’s company name. Will become the `name` property once / if the affiliate is approved. - **website** (string) - Optional - The affiliate’s website. - **advertise_method_description** (string) - Optional - Method used by the affiliate to advertise. - **custom_terms** (string) - Optional - Network defined custom terms and conditions that the affiliate accepted. - **platform_terms** (string) - Optional - Everflow’s terms and conditions that the affiliate accepted. - **contact_address** (object) - Optional - The affiliate’s contact address information. Only required if “is_contact_address_enabled” is set to true. - **address_1** (string) - Required - The address first line. - **address_2** (string) - Optional - The address second line. - **city** (string) - Required - The city name. - **region_code** (string) - Required - The region code. Can be found using the metadata API. - **country_code** (string) - Required - The country code. Can be found using the metadata API. - **zip_postal_code** (string) - Required - The ZIP or Postal code. - **referral_code** (string) - Optional - Referral code used by the affiliate. - **tax_id** (string) - Optional - Affiliate’s tax ID (used for billing). - **affiliate_manager_encoded_value** (string) - Optional - Affiliate manager’s encoded ID. - **referrer_encoded_value** (string) - Optional - Encoded value of the affiliate ID that referred the new sign up. - **billing** (object) - Required - The affiliate’s billing information. - **payment_type** (string) - Required - The affiliate’s payment type. Can be one of the following values: `none`, `pay`, `paypal`, `check`, `wire`, `direct_deposit`, `tipalti`, `payum`, `veem`, `payoneer`, `bitcoin`, `webmoney`, `capitalist`, `transferwise`, `gift_card`, `masspay` or `skrill`. - **billing** (object) - Required when `payment_type` is not `none`. The affiliate’s payment method details. - **paxum_id** (string) - Required when `payment_type` is set to `paxum`. - **paypal_reception_method** (string) - Required when `payment_type` is set to `paypal`. Can be either `email`, `phone` or `paypal_account`. - **reception_identifier** (string) - Required when `payment_type` is set to `paypal`. - **email** (string) - Required when `payment_type` is set to `payoneer` or `veem`. - **is_existing_payee** (boolean) - Required when `payment_type` is set to `tipalti`. - **idap** (string) - Required when `payment_type` is set to `tipalti` and `is_existing_payee` is set to true. - **first_name** (string) - Required when `payment_type` is set to `veem`. - **last_name** (string) - Required when `payment_type` is set to `veem`. - **phone** (string) - Required when `payment_type` is set to `veem`. Must be international format. - **country_iso** (string) - Required when `payment_type` is set to `veem`. - **bank_name** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. - **bank_address** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. - **account_name** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. - **account_number** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. - **routing_number** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. - **swift_code** (string) - Required when `payment_type` is set to `wire` or `direct_deposit`. ### Request Example ```json { "firstname": "John", "lastname": "Doe", "email": "john.doe@example.com", "legal_type": "individual", "company": "Example Corp", "website": "https://example.com", "advertise_method_description": "Blog posts and social media", "contact_address": { "address_1": "123 Main St", "city": "Anytown", "region_code": "CA", "country_code": "US", "zip_postal_code": "12345" }, "billing": { "payment_type": "paypal", "paypal_reception_method": "email", "reception_identifier": "john.doe@example.com" } } ``` ### Response #### Success Response (200) - **affiliate_id** (string) - The unique identifier for the newly created affiliate. - **status** (string) - The status of the affiliate signup (e.g., 'pending', 'approved'). #### Response Example ```json { "affiliate_id": "aff_12345abcde", "status": "pending" } ``` #### Error Response (400, 422, 500) - **error** (string) - A message describing the error. - **details** (object) - Additional details about the error, potentially including specific field validation issues. ``` -------------------------------- ### Example Payload: Fetch Active Offers Source: https://developers.everflow.io/docs/network/offers A JSON payload example for fetching active offers. This payload is used with the '/v1/networks/offerstable' endpoint to filter offers based on their status. ```json { "filters": { "offer_status": "active" } } ``` -------------------------------- ### Connection Response Example Source: https://developers.everflow.io/docs/partner/connections This is an example of the JSON response received after fetching connections. It includes details about each connection, such as partner and network IDs, status, and associated relationship information. ```json { "connections": [ { "partner_id": 23, "network_id": 1234, "network_affiliate_id": 83, "network_affiliate_user_id": 129, "status": "pending", "time_created": 1699378453, "relationship": { "network": { "network_id": 1234, "signup_url": "https://some-brand.everflowclient.io/affiliate/signup/?r=4ZDH6G", "name": "Some Example Brand Inc", "logo_image_url": "https://assets.efusercontent.com/1234/assets/logo/c8f53b52-4be4-e632-a9e5-0218ad6a157f.png", "login_url": "https://dashlane.everflowclient.io/login", "timezone_id": 0 }, "demand_partner": { "everxchange_demand_partner_id": 155, "network_id": 1234, "company_name": "Some Example Brand Inc", "logo_url": "https://assets.efusercontent.com/exc_partner_logos/assets/f7e0797e-0b0d-3fb3-bac3-a40027045c87/some-brand-logo.png", "logo_asset_id": 680, "website_url": "http://some-brand.example", "public_description": "Some Brand is an example brand for the API docs that doesn't actually exist", "facebook_contact_url": "", "instagram_contact_url": "", "twitter_contact_url": "", "time_created": 1601064273, "time_saved": 1685551686, "relationship": { "vertical_ids": [], "channel_ids": [], "geo_vertical_ids": [], "contact": { "fist_name": "John", "last_name": "Doe", "phone_number": "", "email": "john.doe@example.com" }, "payout_type_ids": [] }, "is_contact_info_public": false, "tiktok_contact_url": "", "youtube_contact_url": "", "linkedin_contact_url": "", "custom_link_label": "", "link": "", "default_network_offer_id": 32, "status": "active", "is_internal": false }, "payments": { "everflow_pay": { "enabled": true }, "tipalti": { "enabled": false }, "trusted_payouts": { "enabled": true }, "managed_payments": { "enabled": false } } } } ], "paging": { "page": 1, "page_size": 100, "total_count": 1 } } ``` -------------------------------- ### Complete Advertiser Signup Request (JSON) Source: https://developers.everflow.io/docs/network/signup An extended JSON structure for advertiser signup, incorporating optional fields like referral codes, tax information, billing details, and custom field values. ```json { "firstname": "John", "lastname": "Doe", "email": "john.doe@example.com", "phone": "555-555-1212", "legal_type": "individual", "company": "Example company", "website": "http://example-website.com", "advertise_method_description": "Facebook, Google Ads", "custom_terms": "", "platform_terms": "", "contact_address": { "address_1": "Address Line 1", "address_2": "Address Line 2", "city": "Example City", "zip_postal_code": "32789", "country_id": 227, "region_code": "FL" }, "referral_code": "facebook", "tax_id" : "...", "billing": { "payment_type": "paypal", "billing": { "paypal_reception_method": "paypal_account", "reception_identifier": "user@example.com" } }, "custom_field_values": [ { "network_signup_custom_field_id": 2, "field_value": "my optional custom field value" }, { "network_signup_custom_field_id": 11, "field_value": "my optional custom field value" }, { "network_signup_custom_field_id": 16, "field_value": "my optional custom field value" } ], "affiliate_manager_encoded_value": "RNK3G2", "referrer_encoded_value": "RNK3G2" } ``` -------------------------------- ### Find All Platforms - API Response Example Source: https://developers.everflow.io/docs/metadata/platforms This snippet shows an example JSON response from the /v1/meta/platforms endpoint. The response contains a list of platforms, each with a unique platform_id and its corresponding name. ```json { "platforms": [ { "platform_id": 1, "name": "Android" }, ..., { "platform_id": 22, "name": "Nintendo OS" } ] } ``` -------------------------------- ### Device Types Response Example Source: https://developers.everflow.io/docs/metadata/device_types An example of the JSON response when successfully retrieving device types from the Everflow API. It includes the device type ID and its corresponding name. ```json { "device_types": [ { "device_type_id": 1, "name": "PC" }, ..., { "device_type_id": 6, "name": "TV" } ] } ``` -------------------------------- ### Copy Offer with Query Parameters (cURL) Source: https://developers.everflow.io/docs/network/offers This example demonstrates how to copy an offer using the Everflow API with cURL. It shows the base endpoint and the inclusion of an API key. Query string parameters can be appended to specify which settings to copy. ```shell curl --request GET 'https://api.eflow.team/v1/networks/offers//copy' \ --header 'X-Eflow-API-Key: ' ```