Everflow – Marketplace API

Docs: Everflow's Marketplace API Model

Mon, 01 Jan 0001 00:00:00 +0000

Partners who participate in the Marketplace on Everflow establish connections with one or multiple brands. Data fetched from the Marketplace API will include relevant information from all the brands with which a connection was established.

For example, when fetching offers from the Marketplace API while being connected to 3 different brands you can expect the following :

Top level model of the Everflow Marketplace API

Everflow, however, is a software provider and does not act like a network. Consequently, each brand actually "owns" their own instance of Everflow from which data is exposed through the Affiliate API.

When Marketplace partners create a connection with a brand in Everflow, they also gain access to the brand's affiliate API which exposes all the data available in the Everflow UI.

The Marketplace API serves as an umbrella over the different brand connections and allows API users to fetch data from all brands in a single call.

Inner workings of the Everflow Marketplace API

In other words, using the Marketplace API is actually optional, since API users are free to access the Affiliate API directly :

Direct connection with a brand's Affiliate API

And since there is no aggregation layer between the Affiliate API and the API user, there are scenarios in which it can be beneficial to access the Affiliate API directly. For example, more filters will be offered on reporting and offer endpoints.

Because Everflow works with a one-instance-per-brand model, power users of the API should explore this way of working, which essentially involves 2 steps :

Fetch the API key associated with each brand the partner is connected with through this endpoint
Use the Affiliate API to accomplish the required task

Direct connection with a brand's Affiliate API

Docs: API Keys

Mon, 01 Jan 0001 00:00:00 +0000

Partners have one or multiple marketplace connections with different brands / networks. For each connection, an affiliate account exists on the brand / network’s Everflow account.

The endpoint documented here allows a partner to fetch all the affiliate API keys associated with their different connections (an affiliate API key will exist for each connection).

Get All API keys

GET /v1/partners/connections/apikeys/list

This endpoint allows you to fetch the API keys associated with each connection that exsits.

The API keys returned here can then be used on the affiliate API to execute calls for a specific connection (or for all of them in a loop).

Although the endpoint returns keys for the affiliate API, a Marketplace API key must be used to make the call

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/partners/connections/apikeys/list' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'

Response

{
  "keys": [
    {
      "advertiser_id": 1,
      "advertiser_name": "Some Brand",
      "api_key": "...."
    },
    {
      "advertiser_id": 5,
      "advertiser_name": "Some Other Brand",
      "api_key": "...."
    }
  ]
}

Docs: Connections

Mon, 01 Jan 0001 00:00:00 +0000

Partners have one or multiple marketplace connections with different Marketplace Advertiser (brands / networks). The operations listed here allow you to fetch informations about these connections.

Fetch All Connections

POST /v1/partners/connections/table

This endpoint allows you to fetch the existing connections between a marketplace partner and marketplace advertisers.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

filters object

Structured filters

View Object Details Hide Object Details

status string

Filter on the status of the connection. Can be one of : active, pending, deleted.

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/partners/connections/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch all pending connections

{
  "filters": {
    "status": "pending"
  }
}

Response

{
  "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
  }
}

Docs: Earnings

Mon, 01 Jan 0001 00:00:00 +0000

Find All Payments

POST /v1/partners/payments

This endpoint allows you to retrieve a list of all payments, with filtering and pagination options.

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Body Params

timezone_id int

The timezone ID for the request.

from string

Start date for filtering payments (format: “yyyy-MM-dd”). Optional if any date filter is provided in the filter object.

to string

End date for filtering payments (format: “yyyy-MM-dd”). Optional if any date filter is provided in the filter object.

query object

Query parameters for filtering payments.

View Object Details Hide Object Details

search_terms object array

Terms used to filter the data.

View Object Details Hide Object Details

search_type string

Type of the terms of the search. Can be one of the following values: network_name.

value string

Value of the term to filter by.

filter object

Structured filters for payments.

View Object Details Hide Object Details

partner_connection_ids int array

List of partner connection IDs to filter by.

payment_types string array

List of payment types to filter by. Can be one of the following values: pay, veem or tipalti.

network_ids int array

List of network IDs to filter by.

payment_status string

Affiliate payment status to filter by. Can be one of the following values: pending, rejected, success or scheduled.

payment_provider_payment_status string

Payment provider status to filter by. Can be one of the following values: unpaid, in_progress, paid or rejected.

time_created_from string

Start date for filtering by creation time (format: “yyyy-MM-dd”).

time_created_to string

End date for filtering by creation time (format: “yyyy-MM-dd”).

time_approved_from string

Start date for filtering by approval time (format: “yyyy-MM-dd”).

time_approved_to string

End date for filtering by approval time (format: “yyyy-MM-dd”).

time_completed_from string

Start date for filtering by completion time (format: “yyyy-MM-dd”).

time_completed_to string

End date for filtering by completion time (format: “yyyy-MM-dd”).

Examples

The following examples are different variations of what you can pass as a payload in the following call :

cURL

curl --request POST 'https://api.eflow.team/v1/partners/payments' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Fetch payments for a specific date range and filter by status

{
  "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"
    }
  }
}

To fetch payments using Example 1, you would run the following call:

curl --request POST 'https://api.eflow.team/v1/partners/payments?page=1&page_size=100' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "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"
    }
  }
}'

Example 2 : Fetch payments filtering by creation and completion dates

{
  "timezone_id": 80,
  "query": {
    "filter": {
      "time_created_from": "2025-11-01",
      "time_created_to": "2025-11-15",
      "time_completed_from": "2025-11-01",
      "time_completed_to": "2025-11-30"
    }
  }
}

To fetch payments using Example 2, you would run the following call:

curl --request POST 'https://api.eflow.team/v1/partners/payments?page=1&page_size=100' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "timezone_id": 80,
  "query": {
    "filter": {
      "time_created_from": "2025-11-01",
      "time_created_to": "2025-11-15",
      "time_completed_from": "2025-11-01",
      "time_completed_to": "2025-11-30"
    }
  }
}'

Response

{
    "payments": [
        {
            "partner_payment_id": 17,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 33,
            "payment_type": "tipalti",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 1108.8445,
            "currency": "GBP",
            "network_name": "Network Name",
            "payee_original_amount": 29179679.02,
            "payee_fee_amount": 755753.93,
            "payee_paid_amount": 28423925.09,
            "payee_currency": "VND",
            "network_affiliate_payment_id": 45,
            "network_affiliate_invoice_id": 84,
            "time_created": 1762890676,
            "time_approved": 1762890817,
            "time_completed": 1762892530
        },
        {
            "partner_payment_id": 18,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 33,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 283.55,
            "currency": "GBP",
            "network_name": "Network Name",
            "payee_original_amount": 7461760.02,
            "payee_fee_amount": 193259.64,
            "payee_paid_amount": 7268500.38,
            "payee_currency": "VND",
            "network_affiliate_payment_id": 46,
            "network_affiliate_invoice_id": 85,
            "time_created": 1762890794,
            "time_approved": 1762891243,
            "time_completed": 1762892527
        },
        {
            "partner_payment_id": 21,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 380.91,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 380.91,
            "payee_fee_amount": 0,
            "payee_paid_amount": 380.91,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 47,
            "network_affiliate_invoice_id": 86,
            "time_created": 1762892408,
            "time_approved": 1762892672,
            "time_completed": 1762892974
        },
        {
            "partner_payment_id": 22,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "pay",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 382.91,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 382.91,
            "payee_fee_amount": 0,
            "payee_paid_amount": 382.91,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 48,
            "network_affiliate_invoice_id": 89,
            "time_created": 1762892976,
            "time_approved": 1762893007,
            "time_completed": 1762893346
        },
        {
            "partner_payment_id": 23,
            "partner_id": 17,
            "network_id": 15,
            "partner_connection_id": 34,
            "payment_type": "veem",
            "payment_status": "success",
            "payment_provider_payment_status": "paid",
            "time_invoice_approved": 0,
            "time_payment_approved": 0,
            "time_payment_completed": 0,
            "amount": 100,
            "currency": "USD",
            "network_name": "Network Name",
            "payee_original_amount": 100,
            "payee_fee_amount": 0,
            "payee_paid_amount": 100,
            "payee_currency": "USD",
            "network_affiliate_payment_id": 52,
            "network_affiliate_invoice_id": 93,
            "time_created": 1763066964,
            "time_approved": 1763067256,
            "time_completed": 1763067331
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 100,
        "total_count": 5
    }
}

Docs: Marketplace Advertisers

Mon, 01 Jan 0001 00:00:00 +0000

The Marketplace Advertiser Object

The Marketplace Advertiser object returned by the API endpoints documented here can be defined as such :

Body Fields

everxchange_demand_partner_id int

The Marketplace Advertiser’s unique ID

network_id int

The Everflow Network or “client” ID for this advertiser. This ID would be same as the one used on all the other Everflow APIs (network, affiliate, etc.)

company_name string

The Everflow Network or “client” ID for this advertiser. This ID would be same as the one used on all the other Everflow APIs (network, affiliate, etc.)

status string

The Marketplace Advertiser’s account status. Can be either active or deleted

logo_url string

Marketplace Advertiser’s logo. This asset will always be hosted on an Everflow’s domain

logo_asset_id int

Unique ID of the logo’s asset

website_url string

The Marketplace Advertiser’s website

public_description string

A description of the company, written by the Marketplace Advertiser themselves

facebook_contact_url string

An optional link to the Marketplace Advertiser’s Facebook presence

instagram_contact_url string

An optional link to the Marketplace Advertiser’s Instagram presence

twitter_contact_url string

An optional link to the Marketplace Advertiser’s Twitter presence

tiktok_contact_url string

An optional link to the Marketplace Advertiser’s TikTok presence

linkedin_contact_url string

An optional link to the Marketplace Advertiser’s LinkedIn presence

youtube_contact_url string

An optional link to the Marketplace Advertiser’s Youtube presence

is_contact_info_public boolean

Determines whether the Marketplace Advertiser chose to make their contact information available publicly

link string

An option for the Marketplace Advertiser to provide a link relevant to their program (e.g. Telegram Group invite, Relevant information stored elsewhere, etc.)

custom_link_label string

Only relevant if the link field documented above is filled. Describes what the link is about.

default_network_offer_id int

Certain Publishers (Marketplace Partners) require Marketplace Advertisers they connect with to provide an always-accessible, public, Default Marketplace Offer. This field will return the offer ID of the Default Marketplace Offer if it has been set by the Advertiser, otherwise it will return 0.

Get All Marketplace Advertisers

POST /v1/partners/marketplace/demands

This endpoint return a list of Marketplace Advertisers. The response will not contain the Marketplace Advertisers you are already connected with.

Though this endpoint is a POST it does not currently support filters. You can therefore use it by passing an empty JSON body.

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/partners/marketplace/demands \
  --header 'Content-Type: application/json' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --data '{
}'

Example 1 : Fetch all Marketplace Advertisers

Response

{
  "demand_partners": [
    {
      "everxchange_demand_partner_id": 19,
      "network_id": 7234,
      "company_name": "Example.com",
      "status": "active",
      "logo_url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
      "logo_asset_id": 147,
      "website_url": "http://example.com",
      "public_description": "A placeholder brand that's used for API documentation",
      "facebook_contact_url": "",
      "instagram_contact_url": "",
      "twitter_contact_url": "",
      "is_contact_info_public": true,
      "tiktok_contact_url": "",
      "youtube_contact_url": "",
      "linkedin_contact_url": "",
      "custom_link_label": "",
      "link": "",
      "default_network_offer_id": 0,
      "time_created": 1574814836,
      "time_saved": 1717529716,
      "relationship": {
        "vertical_ids": [
          9,
          10,
          16,
          17
        ],
        "channel_ids": [
          3,
          6,
          10,
          14,
          16,
          20,
          22,
          26,
          27,
          28
        ],
        "geo_vertical_ids": [
          1001
        ],
        "contact": {
          "fist_name": "John",
          "last_name": "Doe",
          "phone_number": "",
          "email": "john.doe@example.com"
        },
        "affinity_match_count": 2,
        "resource_asset": {
          "customer_asset_id": 147,
          "content_type": "image/png",
          "filename": "example.png",
          "url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
          "file_size": 13635,
          "time_saved": 1652712073
        },
        "payments": {
          "everflow_pay": {
            "enabled": true
          },
          "tipalti": {
            "enabled": false
          },
          "trusted_payouts": {
            "enabled": true
          },
          "managed_payments": {
            "enabled": false
          }
        },
        "programs": [
          {
            "everxchange_demand_partner_program_id": 247,
            "everxchange_demand_partner_id": 19,
            "name": "Example",
            "preview_url": "https://example.com/",
            "ordering_value": 1,
            "time_created": 1717529716,
            "time_saved": 1717529716
          }
        ],
        "performance": {
          "everxchange_demand_partner_id": 19,
          "clicks_weekly": 123042,
          "has_reached_weekly_threshold": false,
          "epc_weekly": 0.1906,
          "cvr_weekly": 0.0576,
          "clicks_monthly": 834925,
          "has_reached_monthly_threshold": false,
          "epc_monthly": 0.2147,
          "cvr_monthly": 0.0643,
          "time_created": 1695804176,
          "time_saved": 1730450196
        },
        "payout_type_ids": [
          4
        ],
        "network_currency_id": "USD"
      }
    }
  ]
}

Get Marketplace Advertiser By ID

GET /v1/partners/marketplace/demands/:marketplaceAdvertiserId

This endpoint returns the details of a specific Marketplace Advertiser ID.

Request Example

cURL

curl --request GET \
  --url 'https://api.eflow.team/v1/partners/marketplace/demands/<everxchange_demand_partner_id>' \
  --header 'Content-Type: application/json' \
  --header 'x-eflow-api-key: <INSERT API KEY>'

Example 1 : Fetch a Marketplace Advertiser

Response

{
  "demand_partners": [
    {
      "everxchange_demand_partner_id": 19,
      "network_id": 7234,
      "company_name": "Example.com",
      "status": "active",
      "logo_url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
      "logo_asset_id": 147,
      "website_url": "http://example.com",
      "public_description": "A placeholder brand that's used for API documentation",
      "facebook_contact_url": "",
      "instagram_contact_url": "",
      "twitter_contact_url": "",
      "is_contact_info_public": true,
      "tiktok_contact_url": "",
      "youtube_contact_url": "",
      "linkedin_contact_url": "",
      "custom_link_label": "",
      "link": "",
      "default_network_offer_id": 0,
      "time_created": 1574814836,
      "time_saved": 1717529716,
      "relationship": {
        "vertical_ids": [
          9,
          10,
          16,
          17
        ],
        "channel_ids": [
          3,
          6,
          10,
          14,
          16,
          20,
          22,
          26,
          27,
          28
        ],
        "geo_vertical_ids": [
          1001
        ],
        "contact": {
          "fist_name": "John",
          "last_name": "Doe",
          "phone_number": "",
          "email": "john.doe@example.com"
        },
        "affinity_match_count": 2,
        "resource_asset": {
          "customer_asset_id": 147,
          "content_type": "image/png",
          "filename": "example.png",
          "url": "https://assets.efusercontent.com/exc_partner_logos/assets/example.png",
          "file_size": 13635,
          "time_saved": 1652712073
        },
        "payments": {
          "everflow_pay": {
            "enabled": true
          },
          "tipalti": {
            "enabled": false
          },
          "trusted_payouts": {
            "enabled": true
          },
          "managed_payments": {
            "enabled": false
          }
        },
        "programs": [
          {
            "everxchange_demand_partner_program_id": 247,
            "everxchange_demand_partner_id": 19,
            "name": "Example",
            "preview_url": "https://example.com/",
            "ordering_value": 1,
            "time_created": 1717529716,
            "time_saved": 1717529716
          }
        ],
        "performance": {
          "everxchange_demand_partner_id": 19,
          "clicks_weekly": 123042,
          "has_reached_weekly_threshold": false,
          "epc_weekly": 0.1906,
          "cvr_weekly": 0.0576,
          "clicks_monthly": 834925,
          "has_reached_monthly_threshold": false,
          "epc_monthly": 0.2147,
          "cvr_monthly": 0.0643,
          "time_created": 1695804176,
          "time_saved": 1730450196
        },
        "payout_type_ids": [
          4
        ],
        "network_currency_id": "USD"
      }
    }
  ]
}

Docs: Offers

Mon, 01 Jan 0001 00:00:00 +0000

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": "https://tracking-link.com/QL3F2/2CTPL/"
    }
  ],
  "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": "https://tracking-link.com/QL3F2/2CTPL/"
}