Everflow – Reporting

Docs: Aggregated Data Reports

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

Aggregated data reports endpoints are the most powerful reports in the Everflow platform. They power many different reports in the UI and allow you to pull reporting metrics by pivoting your data based on one or multiple columns. Concretely, the report will allow you to, for example, pull all reporting metrics per offer, effectively turning each offer into a reporting “line”.

Using multiple columns like "offer" and "affiliate" would mean that each reporting “line” is a unique couple of offer / affiliate.

The endpoints documented here all support the same columns and can take up to 10 columns in a single request. At least one column must be specified in each request.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

View Columns

Note that you can only use a single time-related column at a time. For example, using both week and hour at the same time won’t work.

Column	Description
offer	Group by offer id
affiliate	Group by affiliate id
advertiser	Group by advertiser id
offer_group	Group by offer_group id
campaign	Group by network campaign id
creative	Group by creative id
event_name	Group by event id
offer_url	Group by offer url id
country	Group by country
country_code	Group by country code
region	Group by region
city	Group by city
dma	Group by dma
carrier	Group by carrier
platform	Group by platform
os_version	Group by os version
isp	Group by isp
browser	Group by browser
device_type	Group by device type
device_make	Group by device brand (make)
model	Group by device model
language	Group by language
connection_type	Group by connection type
sub1	Group by sub1 value (same for sub2-5)
source_id	Group by source id
adv1	Group by adv1 value (same for adv2-5)
coupon_code	Group by coupon code
tracking_domain	Group by network tracking domain id
referer	Group by referer
offer_status	Group by offer status
affiliate_manager	Group by affiliate manager id
account_manager	Group by account manager id
category	Group by category id
project_id	Group by project id
payout_type	Group by payout type
payout_amount	Group by payout amount
revenue_type	Group by revenue type
revenue_amount	Group by revenue amount
currency	Group by currency id
sales_manager	Group by sales manager id
account_executive	Group by account executive id
affiliate_status	Group by affiliate status
advertiser_event_name	Group by advertiser global event id
app_identifier	Group by app identifier
bundle_id	Group by bundle id

Table

POST /v1/networks/reporting/entity/table

The main endpoint on which you can pivot your data. Each request must contain :

from and to dates
timezone_id used for the request. Find all timezones here
currency_id used for the reporting metrics
At least one column

Optional query filters can then be added to the call.

Please note that the endpoint is limited to 10,000 rows. If you hit the limit, response will include "incomplete_results": true in the payload. When that’s the case, either reduce the number of columns or reduce the scope of the report you are requesting.

Query Filters

Query filters allow you to limit the scope of the report returned by the API. You could create a filter to limit the reporting data to a single partner for example. You can use multiple filters in a request.

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Exclusion Filters

Exclusions are similar to query filters, but instead of forcing you to include many different values they allow you to exclude a single entity. Pulling reporting data for all but a single partner for example :

{
  //...
  "query": {
    "exclusions": [
      {
        "filter_id_value": "100",
        "resource_type": "affiliate"
      }
    ]
  }
}

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, account_manager, affiliate_manager, category, billing_frequency, country, country_code, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, offer_status, sub1, sub2, sub3, sub4, sub5, channel, coupon_code, affiliate_tier

Additional Settings

Aggregated data requests also support 3 entirely optional settings :

ignore_fail_traffic : defaults to false when omitted – can be used to exclude fail traffic from results
only_include_fail_traffic : defaults to false – opposite of the setting above
campaign_data_only : defaults to false – the word “campaign” in this context refers to smart links. Turning this on will only return the metrics for traffic that was sent through a smart link.

{
  //...
  "query": {
    "settings": {
      "campaign_data_only": false,
      "ignore_fail_traffic": false,
      "only_include_fail_traffic": false
    }
  }
}

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/networks/reporting/entity/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'

Example 1 : Pull all reporting data for the 8th of February 2022 (from midnight until 23h59:59) broken down by offer and affiliate

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ],
    "query": {
        "filters": [ ]
    }
}

Example 2 : Include only traffic that comes from the US or Canada and that has the "internal" value passed as a sub1. Break the data down by device type

{
    "from": "2022-02-01",
    "to": "2022-02-07",
    "timezone_id": 90,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "device_type"
        }
    ],
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "internal",
                "resource_type": "sub1"
            },
            {
                "filter_id_value": "Canada",
                "resource_type": "country"
            },
            {
                "filter_id_value": "United States",
                "resource_type": "country"
            }
        ]
    }
}

Example 3 : Reporting metrics per affiliate on 2 offers for all but one affiliate

{
    "from": "2022-02-01",
    "to": "2022-02-02",
    "timezone_id": 90,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "affiliate"
        }
    ],
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ],
        "exclusions":
        [
            {
                "filter_id_value": "1",
                "resource_type": "affiliate"
            }
        ]
    }
}

Example 4 : Reporting metrics for all smart links currently running, broken down per smart link / destination offer :

{
    "from": "2022-02-01",
    "to": "2022-02-01",
    "timezone_id": 80,
    "currency_id": "USD",
    "columns":
    [
        {
            "column": "campaign"
        },
        {
            "column": "offer"
        }
    ],
    "query":
    {
        "settings":
        {
            "campaign_data_only": true,
            "ignore_fail_traffic": false
        }
    }
}

Response

The response from this endpoint varies depending on the columns you requested. The structure will always be the same though, and the reporting metrics included in the response do not vary either.

Note that whenever the offer column is requested, the advertiser column is always included in the response on top of the offer column.

The usm_columns and custom_metric_columns will be filled with any user management and custom metrics you created (they are optional).

Given the following request payload :

{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ]
}

The response would look like :

{
    "table": [
        {
            "columns": [
                {
                    "column_type": "offer",
                    "id": "879",
                    "label": "Example Offer Name"
                },
                {
                    "column_type": "advertiser",
                    "id": "135",
                    "label": "Example Advertiser Name"
                },
                {
                    "column_type": "affiliate",
                    "id": "20019",
                    "label": "Partner Inc."
                }
            ],
            "reporting": {
                "imp": 0,
                "total_click": 75,
                "unique_click": 75,
                "invalid_click": 7027,
                "duplicate_click": 0,
                "gross_click": 7102,
                "ctr": 0,
                "cv": 0,
                "invalid_cv_scrub": 0,
                "view_through_cv": 0,
                "total_cv": 0,
                "event": 0,
                "cvr": 0,
                "evr": 0,
                "cpc": 0,
                "cpm": 0,
                "cpa": 0,
                "epc": 0,
                "rpc": 0,
                "rpa": 0,
                "rpm": 0,
                "payout": 0,
                "revenue": 0,
                "event_revenue": 0,
                "gross_sales": 0,
                "profit": 0,
                "margin": 0,
                "roas": 0,
                "avg_sale_value": 0,
                "media_buying_cost": 0
            }
        },
        {
            "columns": [
                {
                    "column_type": "offer",
                    "id": "881",
                    "label": "Other Example Offer"
                },
                {
                    "column_type": "advertiser",
                    "id": "135",
                    "label": "Example AdvertiserName"
                },
                {
                    "column_type": "affiliate",
                    "id": "20017",
                    "label": "Other Partner Inc."
                }
            ],
            "reporting": {
                "imp": 0,
                "total_click": 0,
                "unique_click": 0,
                "invalid_click": 2693,
                "duplicate_click": 0,
                "gross_click": 2693,
                "ctr": 0,
                "cv": 0,
                "invalid_cv_scrub": 0,
                "view_through_cv": 0,
                "total_cv": 0,
                "event": 0,
                "cvr": 0,
                "evr": 0,
                "cpc": 0,
                "cpm": 0,
                "cpa": 0,
                "epc": 0,
                "rpc": 0,
                "rpa": 0,
                "rpm": 0,
                "payout": 0,
                "revenue": 0,
                "event_revenue": 0,
                "gross_sales": 0,
                "profit": 0,
                "margin": 0,
                "roas": 0,
                "avg_sale_value": 0,
                "media_buying_cost": 0
            },
            "usm_columns": [],
            "custom_metric_columns": []
        }
    ]
}

Table Export

POST /v1/networks/reporting/entity/table/export

The table export is basically identical to the table endpoint documented above, except that it lets you “export” the data in CSV or JSON format.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Example

curl --request POST 'https://api.eflow.team/v1/networks/reporting/entity/table/export' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ],
    "query": {
        "filters": [ ]
    },
    "format": "csv"
}'

Summary

POST /v1/networks/reporting/entity/summary

The summary endpoint is useful when you are looking to use the powerful features of the table endpoint documented above but you are only looking for top level reporting metrics.

In other words, this endpoint only returns a single reporting metric “row” that will contain the summary of all the data returned by the table endpoint. When using the Everflow UI, you would see this data in the “Summary” section of your report.

While the response from this endpoint is in no way affected by the columns requested, it is still necessary to include them in the request as the endpoint was always intended to be used in conjunction with the table endpoint.

Reporting summary line in the Everflow UI

Example

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/entity/summary \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '{
    "from": "2022-02-08",
    "to": "2022-02-08",
    "timezone_id": 67,
    "currency_id": "USD",
    "columns": [
        {
            "column": "offer"
        }
    ],
    "query": {
        "filters": [ ]
    }
}'

Response

A single reporting metrics entry :

{
  "imp": 0,
  "total_click": 82630,
  "unique_click": 82630,
  "invalid_click": 51484,
  "duplicate_click": 0,
  "gross_click": 134114,
  "ctr": 0,
  "cv": 1150,
  "invalid_cv_scrub": 21,
  "view_through_cv": 0,
  "total_cv": 1171,
  "event": 611,
  "cvr": 1.417,
  "evr": 52.178,
  "cpc": 0.096,
  "cpm": 0,
  "cpa": 6.786,
  "epc": 0.246,
  "rpc": 0.342,
  "rpa": 24.113,
  "rpm": 0,
  "payout": 7946,
  "revenue": 28236.05,
  "event_revenue": 21709.05,
  "gross_sales": 86989,
  "profit": 20290.05,
  "margin": 71.859,
  "roas": 3.081,
  "avg_sale_value": 74.286,
  "media_buying_cost": 0
}

Reporting Adjustments

GET /v1/networks/reportingadjustments

The following endpoint will return all adjustments made to aggregated reporting as well as a snapshot of what the reporting was prior to the adjustment. This can be useful when trying to reconcile differences between the raw reporting data and the values returned from the endpoints above.

The following query parameters are mandatory in the url on this endpoint in the following format.

Value	Description
to	to date in YYYY-MM-DD format and will utilize network’s timezone
from	from date in YYYY-MM-DD format and will utilize network’s timezone

Example

curl --request GET 'https://api.eflow.team/v1/networks/reportingadjustments?to=2025-06-23&from=2025-06-23' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Response

An example in which there is an adjustment of a payout of 0 to a payout of 10.

{
  "adjustments": [
    {
      "network_reporting_adjustment_id": 1,
      "network_id": 5,
      "network_affiliate_id": 20509,
      "network_offer_id": 1522,
      "network_employee_id": 1,
      "total_clicks": 0,
      "unique_clicks": 0,
      "conversions": 1,
      "payout": 10,
      "revenue": 0,
      "date_adjustment": "2025-06-23",
      "notes": "",
      "gross_sales": 0,
      "impressions": 0,
      "media_buying_cost": 0,
      "time_created": 1750800448,
      "time_saved": 1750800448,
      "deleted": false,
      "relationship": {
        "snapshot": {
          "network_reporting_adjustment_id": 1,
          "network_id": 5,
          "network_affiliate_id": 20509,
          "network_offer_id": 1522,
          "total_clicks": 0,
          "unique_clicks": 0,
          "conversions": 1,
          "payout": 0,
          "revenue": 0,
          "event_revenue": 0,
          "gross_sales": 0,
          "impressions": 0,
          "media_buying_cost": 0,
          "snapshot_timestamp": 1750629600,
          "snapshot_date": "2025-06-23",
          "time_created": 1750800448
        }
      }
    }
  ]
}

Docs: Dashboard Stats

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

Dashboard Summary

This endpoint is used to generate the cards at the top of the Everflow dashboard page in the UI. It lists comparative data for standard reporting metrics such as payout, revenue, number of clicks, etc. over time.

For every metric, values for current month vs total of last month and today vs total of yesterday are listed.

Performance values are computed by comparing yesterday value at the same moment of the day as now.

GET /v1/networks/dashboard/summary

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/dashboard/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "revenue":
    {
        "today": 28576.65,
        "yesterday": 41199.12,
        "current_month": 270315.70,
        "last_month": 929350.99,
        "trending_percentage": -23.4
    },
    "payout":
    {
        "today": 8060.50,
        "yesterday": 9692.5664,
        "current_month": 76260.50,
        "last_month": 258850.17,
        "trending_percentage": -5.7
    },
    "profit":
    {
        "today": 20516.15,
        "yesterday": 31506.55,
        "current_month": 194055.19,
        "last_month": 670500.82,
        "trending_percentage": -28.6
    },
    "margin":
    {
        "today": 71.793,
        "yesterday": 76.474,
        "current_month": 71.788,
        "last_month": 72.147
    },
    "click":
    {
        "today": 84386,
        "yesterday": 112299,
        "current_month": 780852,
        "last_month": 3089428,
        "trending_percentage": -16.9
    },
    "conversion":
    {
        "today": 1188,
        "yesterday": 1320,
        "current_month": 10674,
        "last_month": 36741,
        "trending_percentage": 1.7
    },
    "event":
    {
        "today": 619,
        "yesterday": 837,
        "current_month": 5887,
        "last_month": 20056,
        "trending_percentage": -17.6
    },
    "cvr":
    {
        "today": 1.408,
        "yesterday": 1.175,
        "current_month": 1.367,
        "last_month": 1.189
    },
    "evr":
    {
        "today": 52.104,
        "yesterday": 63.409,
        "current_month": 55.153,
        "last_month": 54.588
    },
    "cpc":
    {
        "today": 0.096,
        "yesterday": 0.086,
        "current_month": 0.098,
        "last_month": 0.084
    },
    "epc":
    {
        "today": 0.243,
        "yesterday": 0.281,
        "current_month": 0.249,
        "last_month": 0.217
    },
    "rpc":
    {
        "today": 0.339,
        "yesterday": 0.367,
        "current_month": 0.346,
        "last_month": 0.301
    },
    "rpm":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "cpm":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "gross_sales":
    {
        "today": 87996,
        "yesterday": 106358,
        "current_month": 814262,
        "last_month": 2819896,
        "trending_percentage": -6.9
    },
    "gross_click":
    {
        "today": 136836,
        "yesterday": 158173,
        "current_month": 1245805,
        "last_month": 4900458,
        "trending_percentage": -2.4
    },
    "impression":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "ctr":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "invalid_click":
    {
        "today": 52450,
        "yesterday": 45874,
        "current_month": 464953,
        "last_month": 1811030,
        "trending_percentage": 35.4
    },
    "duplicate_click":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 20,
        "last_month": 63,
        "trending_percentage": 0
    },
    "unique_click":
    {
        "today": 84386,
        "yesterday": 112299,
        "current_month": 780832,
        "last_month": 3089365,
        "trending_percentage": -16.9
    },
    "view_through_conversion":
    {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "approved_conversion":
    {
        "today": 1166,
        "yesterday": 1304,
        "current_month": 10510,
        "last_month": 36156,
        "trending_percentage": 1
    },
    "throttled_conversion":
    {
        "today": 22,
        "yesterday": 16,
        "current_month": 164,
        "last_month": 585,
        "trending_percentage": 57.1
    }
}

Docs: Raw Clicks Report

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

In the endpoints documented here, each click is a “row” in the response. The data is not aggregated.

Are you looking to fetch all your clicks? If so, the Firehose might be suited for your use case.

Important: While the clicks analytics are kept forever, the raw data used to create the response on these endpoints is only kept for a period of 3 months on the Everflow servers. Requests for time intervals that go beyond that period will not return clicks. Raw data for clicks that lead to conversions, however, is kept forever.

Click Report

POST /v1/networks/reporting/clicks/stream

This endpoint is used to extract a raw list of clicks. In the result of this request, each click will be one element / row. To avoid extremely slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of clicks that can be returned by this endpoint is : 10 000. If there are more than 10 000 clicks that match the request, they will not be returned.

Requests are only allowed for a period of 14 days of less. Requesting a longer period will result in an error (400 bad request).

This endpoint should not be used to extract every click from the platform. Requests to extracts large lists of clicks should be made via the Request Report feature.

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, account_manager, affiliate_manager, category, billing_frequency, country, region, city, dma, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, isp, offer_status, s1, s2, s3, s4, s5, channel, coupon_code, affiliate_tier

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/clicks/stream \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Include only clicks that comes from the US or Canada and that have the "internal" value passed as a sub1.

{
    "from": "2022-02-08 16:30:00",
	"to": "2022-02-08 16:45:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "internal",
                "resource_type": "s1"
            },
            {
                "filter_id_value": "Canada",
                "resource_type": "country"
            },
            {
                "filter_id_value": "United States",
                "resource_type": "country"
            }
        ]
    }
}

Example 2 : Clicks for all partners on 2 offers

{
    "from": "2022-02-01 12:30:00",
	"to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Clicks that have a sub3 value of "test"

{
    "from": "2022-02-01 12:30:00",
    "to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "test",
                "resource_type": "s3"
            }
        ]
    }
}

Response

{
    "clicks":
    [
		{
		    "transaction_id": "b35dc35c6c804a808782dbecd1e59b04",
		    "is_unique": 1,
		    "unix_timestamp": 1605194171,
		    "tracking_url": "www.tracking-domain.test",
		    "source_id": "",
		    "sub1": "internal",
		    "sub2": "",
		    "sub3": "facebook",
		    "sub4": "",
		    "sub5": "",
		    "payout_type": "CPA",
		    "revenue_type": "RPA",
		    "payout": 0,
		    "revenue": 0,
		    "referer": "",
		    "previous_network_offer_id": 0,
		    "error_code": 0,
		    "project_id": "",
		    "user_ip": "35.35.1.89",
		    "error_message": "N/A",
		    "url": "",
		    "is_view_through": false,
		    "is_async": false,
		    "server_side_url": "",
		    "server_side_output": "",
		    "custom_landing_page_id": 0,
		    "is_test_mode": false,
		    "idfa": "",
		    "idfa_md5": "",
		    "idfa_sha1": "",
		    "google_ad_id": "",
		    "google_ad_id_md5": "",
		    "google_ad_id_sha1": "",
		    "android_id": "",
		    "android_id_md5": "",
		    "android_id_sha1": "",
		    "error_filter_id": "",
		    "has_conversion": true,
		    "is_pass_through": false,
		    "creative_id": 0,
		    "relationship": {
		        "offer": {
		            "network_offer_id": 1,
		            "network_id": 1,
		            "network_advertiser_id": 13,
		            "network_offer_group_id": 1,
		            "name": "Example Offer",
		            "offer_status": "active",
		            "network_tracking_domain_id": 1,
		            "visibility": "public",
		            "currency_id": "USD"
		        },
		        "advertiser": {
		            "network_advertiser_id": 13,
		            "network_id": 1,
		            "name": "Example Advertiser Inc.",
		            "account_status": "active"
		        },
		        "account_manager": {
		            "network_employee_id": 2,
		            "network_id": 1,
		            "first_name": "Bob",
		            "last_name": "Smith",
		            "full_name": "Bob Smith",
		            "account_status": "active"
		        },
		        "affiliate": {
		            "network_affiliate_id": 7,
		            "network_id": 1,
		            "name": "Example Partner Inc.",
		            "account_status": "active",
		            "network_traffic_source_id": 0
		        },
		        "affiliate_manager": {
		            "network_employee_id": 2,
		            "network_id": 1,
		            "first_name": "Bob",
		            "last_name": "Smith",
		            "full_name": "Bob Smith",
		            "account_status": "active"
		        },
		        "offer_group": {
		            "network_offer_group_id": 1,
		            "network_id": 1,
		            "network_advertiser_id": 13,
		            "name": "Example Offer Group",
		            "offer_group_status": "active",
		            "offer_count": 0
		        },
		        "geolocation":
		        {
		            "country_code": "JP",
		            "country_name": "Japan",
		            "region_code": "",
		            "region_name": "Gunma",
		            "city_name": "Minakami",
		            "dma": 0,
		            "dma_name": "",
		            "timezone": "Asia/Tokyo",
		            "carrier_name": "",
		            "carrier_code": 0,
		            "organization": "",
		            "isp_name": "Japan Nation-wide Network Of Softbank Corp.",
		            "is_mobile": false,
		            "is_proxy": false,
		            "postal_code": ""
		        },
		        "device_information": {
		            "is_mobile": false,
		            "platform_name": "macOS",
		            "os_version": "10.15",
		            "brand": "Apple",
		            "model": "Macintosh",
		            "is_tablet": false,
		            "browser_name": "Chrome",
		            "browser_version": "86",
		            "device_type": "PC",
		            "language": "en",
		            "http_accept_language": "en-US,en;q=0.9,fr;q=0.8",
		            "is_robot": false,
		            "is_filter": false
		        },
		        "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36",
		        "http_accept_language": "en-US,en;q=0.9,fr;q=0.8",
		        "query_parameters": {},
		        "redirect_url": "http://example.com/test.php?aid=7&oid=1&tid=b35dc35c6c804a808782dbecd1e59b04",
		        "forensiq_score": "0"
		    },
		    "coupon_code": "",
		    "redirect_method": "standard",
		    "is_sdk_click": false,
		    "category_id": 1,
		    "currency_id": "USD"
		}
    ]
}

Click By ID

GET /v1/networks/reporting/clicks/:transactionId

Fetch a single click by its unique Everflow transaction ID.

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/clicks/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "transaction_id": "b35dc35c6c804a808782dbecd1e59b04", "is_unique": 1, "unix_timestamp": 1605194171, "tracking_url": "www.tracking-domain.test", "source_id": "", "sub1": "internal", "sub2": "", "sub3": "facebook", "sub4": "", "sub5": "", "payout_type": "CPA", "revenue_type": "RPA", "payout": 0, "revenue": 0, "referer": "", "previous_network_offer_id": 0, "error_code": 0, "project_id": "", "user_ip": "35.35.1.89", "error_message": "N/A", "url": "", "is_view_through": false, "is_async": false, "server_side_url": "", "server_side_output": "", "custom_landing_page_id": 0, "is_test_mode": false, "idfa": "", "idfa_md5": "", "idfa_sha1": "", "google_ad_id": "", "google_ad_id_md5": "", "google_ad_id_sha1": "", "android_id": "", "android_id_md5": "", "android_id_sha1": "", "error_filter_id": "", "has_conversion": true, "is_pass_through": false, "creative_id": 0, "relationship": { "offer": { "network_offer_id": 1, "network_id": 1, "network_advertiser_id": 13, "network_offer_group_id": 1, "name": "Example Offer", "offer_status": "active", "network_tracking_domain_id": 1, "visibility": "public", "currency_id": "USD" }, "advertiser": { "network_advertiser_id": 13, "network_id": 1, "name": "Example Advertiser Inc.", "account_status": "active" }, "account_manager": { "network_employee_id": 2, "network_id": 1, "first_name": "Bob", "last_name": "Smith", "full_name": "Bob Smith", "account_status": "active" }, "affiliate": { "network_affiliate_id": 7, "network_id": 1, "name": "Example Partner Inc.", "account_status": "active", "network_traffic_source_id": 0 }, "affiliate_manager": { "network_employee_id": 2, "network_id": 1, "first_name": "Bob", "last_name": "Smith", "full_name": "Bob Smith", "account_status": "active" }, "offer_group": { "network_offer_group_id": 1, "network_id": 1, "network_advertiser_id": 13, "name": "Example Offer Group", "offer_group_status": "active", "offer_count": 0 }, "geolocation": { "country_code": "JP", "country_name": "Japan", "region_code": "", "region_name": "Gunma", "city_name": "Minakami", "dma": 0, "dma_name": "", "timezone": "Asia/Tokyo", "carrier_name": "", "carrier_code": 0, "organization": "", "isp_name": "Japan Nation-wide Network Of Softbank Corp.", "is_mobile": false, "is_proxy": false, "postal_code": "" }, "device_information": { "is_mobile": false, "platform_name": "macOS", "os_version": "10.15", "brand": "Apple", "model": "Macintosh", "is_tablet": false, "browser_name": "Chrome", "browser_version": "86", "device_type": "PC", "language": "en", "http_accept_language": "en-US,en;q=0.9,fr;q=0.8", "is_robot": false, "is_filter": false }, "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36", "http_accept_language": "en-US,en;q=0.9,fr;q=0.8", "query_parameters": {}, "redirect_url": "http://example.com/test.php?aid=7&oid=1&tid=b35dc35c6c804a808782dbecd1e59b04", "forensiq_score": "0" }, "coupon_code": "", "redirect_method": "standard", "is_sdk_click": false, "category_id": 1, "currency_id": "USD" }

Flowchart / Transactions

GET /v1/networks/reporting/transactions/:transactionId

This endpoint can be used to retrieve the information from the flowchart in the Everflow UI. While the concept of a flowchart doesn’t make much sense in the context of an API, it can still be useful to get an overview of all the “events” (clicks, conversions, partner postbacks) related to a given transaction ID.

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/transactions/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
    "click":
    {
        "transaction_id": "93680ac61eb047fab77347734520967f",
        "is_unique": 1,
        "unix_timestamp": 1625058552,
        "tracking_url": "www.tracking-domain.com",
        "source_id": "",
        "sub1": "s1",
        "sub2": "",
        "sub3": "facebook",
        "sub4": "",
        "sub5": "app_store",
        "payout_type": "CPA",
        "revenue_type": "RPA",
        "payout": 0,
        "revenue": 0,
        "referer": "",
        "previous_network_offer_id": 0,
        "error_code": 0,
        "project_id": "",
        "user_ip": "74.14.245.141",
        "error_message": "N/A",
        "url": "",
        "is_view_through": false,
        "is_async": false,
        "server_side_url": "",
        "server_side_output": "",
        "custom_landing_page_id": 0,
        "is_test_mode": false,
        "idfa": "",
        "idfa_md5": "",
        "idfa_sha1": "",
        "google_ad_id": "",
        "google_ad_id_md5": "",
        "google_ad_id_sha1": "",
        "android_id": "",
        "android_id_md5": "",
        "android_id_sha1": "",
        "error_filter_id": "",
        "has_conversion": true,
        "is_pass_through": false,
        "creative_id": 0,
        "relationship":
        {
            "offer":
            {
                "network_offer_id": 5,
                "network_id": 1,
                "network_advertiser_id": 13,
                "network_offer_group_id": 0,
                "name": "CPA Offer",
                "offer_status": "active",
                "network_tracking_domain_id": 1,
                "visibility": "require_approval",
                "currency_id": "USD"
            },
            "advertiser":
            {
                "network_advertiser_id": 13,
                "network_id": 1,
                "name": "Ads for Everyone",
                "account_status": "active"
            },
            "account_manager":
            {
                "network_employee_id": 1,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "affiliate":
            {
                "network_affiliate_id": 113,
                "network_id": 1,
                "name": "Digital Supply",
                "account_status": "active",
                "network_traffic_source_id": 0
            },
            "affiliate_manager":
            {
                "network_employee_id": 1,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "geolocation":
            {
                "country_code": "CA",
                "country_name": "Canada",
                "region_code": "QC",
                "region_name": "Quebec",
                "city_name": "Greenfield Park",
                "dma": 0,
                "dma_name": "",
                "timezone": "America/Montreal",
                "carrier_name": "",
                "carrier_code": 0,
                "organization": "Bell Canada",
                "isp_name": "bell canada",
                "is_mobile": false,
                "is_proxy": false,
                "postal_code": "j4v 2v7"
            },
            "device_information":
            {
                "is_mobile": false,
                "platform_name": "macOS",
                "os_version": "10.15",
                "brand": "Apple",
                "model": "Macintosh",
                "is_tablet": false,
                "browser_name": "Chrome",
                "browser_version": "91",
                "device_type": "PC",
                "language": "en",
                "http_accept_language": "en-US,en;q=0.9",
                "is_robot": false,
                "is_filter": false
            },
            "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
            "http_accept_language": "en-US,en;q=0.9",
            "query_parameters":
            {},
            "redirect_url": "https://landing-page.com",
            "forensiq_score": "0"
        },
        "coupon_code": "",
        "redirect_method": "standard",
        "is_sdk_click": false
    },
    "conversions":
    {
        "total": 1,
        "entries":
        [
            {
                "conversion_id": "d51bc674770f40b68a08f8f65fa2a344",
                "conversion_unix_timestamp": 1625058585,
                "sub1": "",
                "sub2": "",
                "sub3": "",
                "sub4": "",
                "sub5": "",
                "source_id": "",
                "status": "approved",
                "payout_type": "cpa",
                "revenue_type": "rpa",
                "payout": 3.5,
                "revenue": 7,
                "session_user_ip": "74.14.245.141",
                "conversion_user_ip": "74.14.245.141",
                "country": "Canada",
                "region": "Quebec",
                "city": "Greenfield Park",
                "dma": 0,
                "carrier": "",
                "platform": "macOS",
                "os_version": "10.15",
                "device_type": "PC",
                "device_model": "",
                "brand": "Apple",
                "browser": "Chrome",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36",
                "adv1": "",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "is_event": false,
                "event": "",
                "notes": "",
                "transaction_id": "93680ac61eb047fab77347734520967f",
                "click_unix_timestamp": 1625058552,
                "error_code": 0,
                "error_message": "N/A",
                "sale_amount": 0,
                "is_scrub": false,
                "coupon_code": "",
                "order_id": "",
                "url": "",
                "isp": "bell canada",
                "referer": "",
                "app_id": "",
                "idfa": "",
                "idfa_md5": "",
                "idfa_sha1": "",
                "google_ad_id": "",
                "google_ad_id_md5": "",
                "google_ad_id_sha1": "",
                "android_id": "",
                "android_id_md5": "",
                "android_id_sha1": "",
                "currency_id": "USD",
                "email": "",
                "is_view_through": false,
                "previous_network_offer_id": 0,
                "relationship":
                {
                    "offer":
                    {
                        "network_offer_id": 5,
                        "network_id": 1,
                        "network_advertiser_id": 13,
                        "network_offer_group_id": 0,
                        "name": "CPA Offer",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1,
                        "visibility": "require_approval",
                        "currency_id": "USD"
                    },
                    "advertiser":
                    {
                        "network_advertiser_id": 13,
                        "network_id": 1,
                        "name": "Ads for Everyone",
                        "account_status": "active"
                    },
                    "account_manager":
                    {
                        "network_employee_id": 1,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "affiliate":
                    {
                        "network_affiliate_id": 113,
                        "network_id": 1,
                        "name": "Digital Supply",
                        "account_status": "active",
                        "network_traffic_source_id": 0
                    },
                    "affiliate_manager":
                    {
                        "network_employee_id": 1,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "query_parameters": {},
                    "attribution_method": "transaction_id",
                    "usm_data": null
                },
                "network_offer_payout_revenue_id": 0
            }
        ]
    },
    "pixels":
    {
        "total": 1,
        "entries":
        [
            {
                "network_id": 1,
                "network_offer_id": 5,
                "network_offer_payout_revenue_id": 0,
                "affiliate_id": 114,
                "pixel_id": 329,
                "conversion_id": "d51bc674770f40b68a08f8f65fa2a344",
                "transaction_id": "93680ac61eb047fab77347734520967f",
                "timestamp": 1625058585,
                "delivery_method": "postback",
                "pixel_level": "global",
                "pixel_status": "active",
                "pixel_type": "conversion",
                "payload": "http://partner-pixel.io/?tid=93680ac61eb047fab77347734520967f",
                "is_success": true,
                "debug_information": "PostbackUrl: http://partner-pixel.io/?tid=93680ac61eb047fab77347734520967f\nStatus: 200\nScheme: \nPath: \nAuthority: \nHeaders: Keep-Alive: [timeout=5, max=100],Server: [Apache/2.4.10 (Debian)],Connection: [Keep-Alive],Content-Length: [61],Date: [Wed, 30 Jun 2021 13:09:45 GMT],Content-Type: [text/html; charset=UTF-8]\nReturn: <pre>Array\n(\n    [tid] => 93680ac61eb047fab77347734520967f\n)\n\n",
                "last_attempt": 0,
                "failed_attempts": 0,
                "relationship":
                {
                    "offer":
                    {
                        "network_offer_id": 5,
                        "network_id": 1,
                        "network_advertiser_id": 13,
                        "network_offer_group_id": 0,
                        "name": "CPA Offer",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1,
                        "visibility": "require_approval",
                        "currency_id": "USD"
                    },
                    "affiliate":
                    {
                        "network_affiliate_id": 113,
                        "network_id": 1,
                        "name": "Digital Supply",
                        "account_status": "active",
                        "network_traffic_source_id": 0
                    }
                }
            }
        ]
    },
    "raw_click": "",
    "on_hold_conversions":
    {
        "total": 0,
        "entries":
        []
    }
}

Docs: Invalid Click Report

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

The endpoints documented in this section allows you to pull invalid click data from the API. Each row will be representative of a click and the data isn’t aggregated.

Invalid Click Report

The maximum number of clicks that can be returned by this endpoint is : 1 000. If there are more than 1 000 clicks that match the request, they will not be returned.

This endpoint should not be used to extract every click from the platform. Requests to extracts large lists of invalid clicks can be made by reaching out to our support team.

POST /v1/networks/reporting/invalidclicks

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

Optional query filters can be added to the call

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "9",
          "resource_type": "error_code"
      }
    ]
  }
}

translate to “Pull invalid clicks with error code 9 (Invalid country) on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, affilate_id, advertiser, creative, offer_group, campaign, transction_id, error_code

Error codes and their reason for failing can be found here

Request Example

cURL

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

Example 1 : Invalid clicks for all partners on 2 offers

{
  "from": "2024-11-31 12:30:00",
  "to": "2024-11-31 13:00:00",
  "timezone_id": 80,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "1522",
        "resource_type": "offer"
      },
      {
        "filter_id_value": "1523",
        "resource_type": "offer"
      }
    ]
  }
}

Example 2 : Invalid clicks that fail because the offer isn’t active being sent to the advertiser

{
  "from": "2024-11-31 12:30:00",
  "to": "2024-11-31 13:00:00",
  "timezone_id": 80,
  "query":
  {
    "filters":
    [
      {
        "filter_id_value": "1008",
        "resource_type": "error_code"
      },
      {
        "filter_id_value": "10",
        "resource_type": "advertiser"
      }
    ]
  }
}

Response

{
			"transaction_id": "9a1f0ce2b0254752827f605467f543c2",
			"is_unique": 1,
			"unix_timestamp": 1731113091,
			"tracking_url": "www.example-domain.com",
			"source_id": "",
			"sub1": "",
			"sub2": "",
			"sub3": "",
			"sub4": "",
			"sub5": "",
			"payout_type": "",
			"revenue_type": "",
			"payout": 0,
			"revenue": 0,
			"referer": "",
			"previous_network_offer_id": 0,
			"error_code": 1018,
			"project_id": "0069Y0000041PAnQAM",
			"user_ip": "39.23.207.68",
			"error_message": "Anura fraud check categorized click as fraud",
			"url": "",
			"is_view_through": false,
			"is_async": false,
			"server_side_url": "",
			"server_side_output": "",
			"custom_landing_page_id": 0,
			"is_test_mode": false,
			"idfa": "",
			"idfa_md5": "",
			"idfa_sha1": "",
			"google_ad_id": "",
			"google_ad_id_md5": "",
			"google_ad_id_sha1": "",
			"android_id": "",
			"android_id_md5": "",
			"android_id_sha1": "",
			"error_filter_id": "",
			"has_conversion": false,
			"is_pass_through": false,
			"creative_id": 0,
			"relationship": {
				"offer": {
					"network_offer_id": 34,
					"network_id": 1,
					"network_advertiser_id": 64,
					"network_offer_group_id": 0,
					"name": "Test Offer",
					"offer_status": "active",
					"network_tracking_domain_id": 8,
					"visibility": "private",
					"currency_id": "USD"
				},
				"advertiser": {
					"network_advertiser_id": 64,
					"network_id": 1,
					"name": "Example Advertiser",
					"account_status": "active"
				},
				"account_manager": {
					"network_employee_id": 5,
					"network_id": 1,
					"first_name": "Jane",
					"last_name": "Doe",
					"full_name": "Jane Doe",
					"account_status": "inactive"
				},
				"affiliate": {
					"network_affiliate_id": 1,
					"network_id": 1,
					"name": "Example Affiliate",
					"account_status": "active",
					"network_traffic_source_id": 5
				},
				"affiliate_manager": {
					"network_employee_id": 10,
					"network_id": 5,
					"first_name": "Bob",
					"last_name": "Smith",
					"full_name": "Bob Smith",
					"account_status": "active"
				},
				"geolocation": {
					"country_code": "US",
					"country_name": "United States",
					"region_code": "",
					"region_name": "District of Columbia",
					"city_name": "Washington",
					"dma": 0,
					"dma_name": "",
					"timezone": "America/New_York",
					"carrier_name": "",
					"carrier_code": 0,
					"organization": "",
					"isp_name": "Google Cloud",
					"is_mobile": false,
					"is_proxy": true,
					"postal_code": "20011"
				},
				"device_information": {
					"is_mobile": false,
					"platform_name": "Unknown",
					"os_version": "",
					"brand": "Unknown",
					"model": "",
					"is_tablet": false,
					"browser_name": "",
					"browser_version": "",
					"device_type": "PC",
					"language": "",
					"http_accept_language": "",
					"is_robot": false,
					"is_filter": false
				},
				"http_user_agent": "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)",
				"query_parameters": {},
				"forensiq_score": "0"
			},
			"coupon_code": "",
			"redirect_method": "standard",
			"is_sdk_click": false,
			"category_id": 17,
			"currency_id": "USD"
		}

Docs: Raw Conversions Report

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

The endpoints documented in this section allow you to pull conversions and post-conversion events from the API. Each conversion / event will be a “row” in the response as the data is not aggregated.

Note that currency conversion is not supported on raw conversion endpoints. Conversions are always stored in the currency of the offer they belong to and this is how the endpoints return raw conversions.

Are you looking to fetch all your conversions? If so, the Firehose might be suited for your use case.

Conversion Report

POST /v1/networks/reporting/conversions

The conversion report is the most flexible way to extract a list of conversions and post-conversion events. It allows you to fetch a list of conversions and post-conversion events while specifying filters to narrow down the scope of the set of data you are pulling.

If you are only looking to pull a limited set of columns in your response, you must use the Conversion Report Export endpoint documented below.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)

Please note that the conversion report is limited to the prior 365 days only and are limited to a maximum duration of one year. Requests outside of this range will result in an error.

Optional query filters can be added to the call

Paging

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

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, offer_group, affiliate, advertiser, offer_creative, transaction_id, campaign, billing_frequency, business_unit, label, category, sub1, sub2, sub3, sub4, sub5, source_id, country, account_manager, affiliate_manager, status, sales_manager, account_executive, offer_url, currency_id, affiliate_tier, adv1, adv2, adv3, adv4, adv5, browser, carrier, city, coupon_code, dma, device_brand, device_type, isp, language, os_version, platform, region, order_id

Additional Settings

Conversion reports support a few more options :

show_only_scrub : defaults to false when omitted – can be used to isolate conversions that were throttled
show_only_vt : defaults to false when omitted – can be used to isolate view-through conversions
show_only_ct : defaults to false when omitted – can be used to isolate click-through events
show_only_fail_traffic : defaults to false when omitted – can be used to isolate conversion and events that come from fail traffic

{
  "from": "2021-10-12",
  //...
  "show_only_scrub": true,
  "show_only_vt": false,
  "show_only_ct": false,
  "show_only_fail_traffic": false,
  "query": {
    // ...
  }
}

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all approved base conversions over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "query":{
        "filters": [
            {
                "filter_id_value": "approved",
                "resource_type": "status"
            }
        ]
    }
}

Conversion status is either approved, pending, rejected or invalid

Example 2 : Pull pending view-through conversions on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "show_only_vt": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "pending",
                "resource_type": "status"
            },
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all conversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Example 4 : Pull base conversions that were generated from a specific advertiser

{
    "from": "2022-02-01",
    "to": "2022-02-01",
    "timezone_id": 90,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "filter_id_value": "135",
                "resource_type": "advertiser"
            }
        ]
    }
}

Response

A response from the conversion report endpoint will look like :

{
    "conversions": [
        {
            "conversion_id": "5d6de3955fcd473fa19ddf33ef9a3b8f",
            "conversion_unix_timestamp": 1643691617,
            "sub1": "inapp",
            "sub2": "external",
            "sub3": "",
            "sub4": "",
            "sub5": "facebook",
            "source_id": "1000",
            "status": "approved",
            "payout_type": "cpa",
            "revenue_type": "rpa",
            "payout": 0.8,
            "revenue": 1,
            "session_user_ip": "80.21.15.xxx",
            "conversion_user_ip": "1.2.3.4",
            "country": "Italy",
            "region": "Milano",
            "city": "Arluno",
            "dma": 0,
            "carrier": "",
            "platform": "iOS",
            "os_version": "10.3",
            "device_type": "Mobile",
            "device_model": "",
            "brand": "Apple",
            "browser": "Facebook for iOS",
            "language": "en",
            "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
            "adv1": "",
            "adv2": "",
            "adv3": "",
            "adv4": "",
            "adv5": "",
            "is_event": false,
            "event": "Example Event",
            "notes": "",
            "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
            "click_unix_timestamp": 1643691604,
            "error_code": 0,
            "error_message": "N/A",
            "sale_amount": 96,
            "is_scrub": false,
            "coupon_code": "",
            "order_id": "",
            "url": "",
            "isp": "telecom italia s.p.a.",
            "referer": "",
            "app_id": "",
            "idfa": "",
            "idfa_md5": "",
            "idfa_sha1": "",
            "google_ad_id": "",
            "google_ad_id_md5": "",
            "google_ad_id_sha1": "",
            "android_id": "",
            "android_id_md5": "",
            "android_id_sha1": "",
            "currency_id": "USD",
            "email": "",
            "is_view_through": false,
            "previous_network_offer_id": 0,
            "relationship": {
                "offer": {
                    "network_offer_id": 882,
                    "network_id": 1,
                    "name": "Example Offer",
                    "offer_status": "active"
                },
                "advertiser": {
                    "network_advertiser_id": 135,
                    "network_id": 1,
                    "name": "Advertiser Inc."
                },
                "account_manager": {
                    "network_employee_id": 15,
                    "network_id": 1,
                    "first_name": "John",
                    "last_name": "Doe",
                    "full_name": "John Doe",
                    "account_status": "active"
                },
                "affiliate": {
                    "network_affiliate_id": 102,
                    "network_id": 1,
                    "name": "Affiliate Inc.",
                    "account_status": "active"
                },
                "affiliate_manager": {
                    "network_employee_id": 8,
                    "network_id": 1,
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "full_name": "Jane Doe",
                    "account_status": "active"
                },
                "query_parameters": {},
                "attribution_method": "cookie",
                "usm_data": null
            },
            "network_offer_payout_revenue_id": 0
        },
        // ...
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 3443
    }
}

Conversion Report Export

POST /v1/networks/reporting/conversions/export

The export endpoint is very similar to the report endpoint documented above but adds 2 possibilities :

It lets you “export” the data in CSV or JSON format
It optionally lets your specify the columns you want included in your report

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

The columns that will be included in the response can also be specified. The possible values are : offer, affiliate, advertiser, offer_group, campaign, affiliate_manager, creative, offer_url, category, previous_offer, source_id, sub1, sub2, sub3, sub4, sub5, adv1, adv2, adv3, adv4, adv5, country, region, city, platform, os_version, isp, account_manager, android_id, android_id_md5, android_id_sha1, app_id, brand, browser, carrier, click_date, conversion_id, conversion_user_ip, coupon_code, currency, delta_hours, device, email, error_message, event_name, google_ad_id, google_ad_id_md5, google_ad_id_sha1, http_user_agent, idfa, idfa_md5, idfa_sha1, language, notes, order_id, order_line_items, order_number, payout, payout_type, referrer, revenue, revenue_type, sale_amount, session_ip, transaction_id, type, status, conversion_date and origin

Examples

cURL

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

Example : Export approved conversions on offer 800 in JSON format. Only include 4 specific columns.

{ "from": "2022-02-07", "to": "2022-02-10", "timezone_id": 80, "show_conversions": true, "show_events": true, "show_only_vt": true, "query":{ "filters": [ { "filter_id_value": "approved", "resource_type": "status" }, { "filter_id_value": "800", "resource_type": "offer" } ] }, "columns": [ "offer", "affiliate", "transaction_id", "conversion_id" ], "format": "json"

}

Conversion By ID

GET /v1/networks/reporting/conversions/:conversionId

Fetch a single conversion by its unique conversion ID.

Path Parameters

Parameter	Description
conversionId	The ID of the conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/conversions/<32 char Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{ "conversion_id": "4b66e71ab68842698fe51002336ff9f9", "conversion_unix_timestamp": 1643692518, "sub1": "internal", "sub2": "gaming", "sub3": "facebook", "sub4": "", "sub5": "", "source_id": "55783", "status": "approved", "payout_type": "cpa", "revenue_type": "rpa", "payout": 3.5, "revenue": 7, "session_user_ip": "208.75.21.101", "conversion_user_ip": "184.151.111.228", "country": "United States", "region": "Michigan", "city": "Ann Arbor", "dma": 505, "carrier": "", "platform": "Android", "os_version": "5.1", "device_type": "Mobile", "device_model": "", "brand": "LG", "browser": "", "language": "", "http_user_agent": "Dalvik/2.1.0 (Linux; U; Android 5.1.1; LG-K330 Build/LMY47V)", "adv1": "", "adv2": "", "adv3": "", "adv4": "", "adv5": "", "is_event": false, "event": "", "notes": "", "transaction_id": "8595ae3b74e841bc9bbcc1560e61283e", "click_unix_timestamp": 1643692502, "error_code": 0, "error_message": "N/A", "sale_amount": 35, "is_scrub": false, "coupon_code": "", "order_id": "", "url": "", "isp": "synergy broadband", "referer": "", "app_id": "", "idfa": "", "idfa_md5": "", "idfa_sha1": "", "google_ad_id": "", "google_ad_id_md5": "", "google_ad_id_sha1": "", "android_id": "", "android_id_md5": "", "android_id_sha1": "", "currency_id": "USD", "email": "", "is_view_through": false, "previous_network_offer_id": 0, "relationship": { "offer": { "network_offer_id": 77, "network_id": 1, "name": "Example Gaming Offer", "offer_status": "active" }, "advertiser": { "network_advertiser_id": 11, "network_id": 1, "name": "Advertiser Inc." }, "account_manager": { "network_employee_id": 15, "network_id": 5, "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "account_status": "active" }, "affiliate": { "network_affiliate_id": 14, "network_id": 1, "name": "Affiliate Inc.", "account_status": "active" }, "affiliate_manager": { "network_employee_id": 87, "network_id": 1, "first_name": "Jane", "last_name": "Doe", "full_name": "Jane Doe", "account_status": "active" }, "query_parameters": { "amount": "3", "nid": "1", "transaction_id": "8595ae3b74e841bc9bbcc1560e61283e" }, "redirect_url": "https://everflow-example.io/?id=8595ae3b74e841bc9bbcc1560e61283e", "snapshots": [ ], "attribution_method": "transaction_id", "usm_data": null }, "network_offer_payout_revenue_id": 0 }

Conversion By Email

POST /v1/networks/reporting/conversions/email

This endpoint can be used to extract a list of conversions / events associated with an email address. The endpoint will return a maximum of 100 conversions (the most recent 100 ones).

Note that conversions older than 1 year may be archived and will not be returned by this endpoint.

The endpoint doesn’t take any filters, only a single email property in the body of the request.

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/conversions/email \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '{
    "email": "test@example.com"
  }'

Response

{
  "conversions": [
    {
      "conversion_id": "1f4a38f373eb12348ba477d3a5b7b65f",
      "conversion_unix_timestamp": 1634568781,
      "sub1": "google",
      "sub2": "facebook",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "source_id": "",
      "status": "approved",
      "payout_type": "cpa",
      "revenue_type": "rpa",
      "payout": 0,
      "revenue": 0,
      "session_user_ip": "1.2.3.4",
      "conversion_user_ip": "10.11.12.13",
      "country": "United States",
      "region": "Wisconsin",
      "city": "Sister Bay",
      "dma": 658,
      "carrier": "",
      "platform": "Android",
      "os_version": "10.0",
      "device_type": "Mobile",
      "device_model": "",
      "brand": "Samsung",
      "browser": "Chrome",
      "language": "en",
      "http_user_agent": "Mozilla/5.0 (Linux; Android 11; SM-G973U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.85 Mobile Safari/537.36",
      "adv1": "",
      "adv2": "",
      "adv3": "",
      "adv4": "",
      "adv5": "",
      "is_event": true,
      "event": "Purchase",
      "notes": "",
      "transaction_id": "78ac316a238b59d48f564431008fd481",
      "click_unix_timestamp": 1634568743,
      "error_code": 0,
      "error_message": "N/A",
      "sale_amount": 0,
      "is_scrub": false,
      "coupon_code": "",
      "order_id": "",
      "url": "",
      "isp": "charter communications",
      "referer": "example.org",
      "app_id": "",
      "idfa": "",
      "idfa_md5": "",
      "idfa_sha1": "",
      "google_ad_id": "",
      "google_ad_id_md5": "",
      "google_ad_id_sha1": "",
      "android_id": "",
      "android_id_md5": "",
      "android_id_sha1": "",
      "currency_id": "USD",
      "email": "test@example.com",
      "is_view_through": false,
      "previous_network_offer_id": 0,
      "relationship": {
        "offer": {
          "network_offer_id": 5,
          "network_id": 1,
          "name": "Example Offer",
          "offer_status": "active"
        },
        "advertiser": {
          "network_advertiser_id": 2,
          "network_id": 1,
          "name": "Advertising Revolution"
        },
        "account_manager": {
          "network_employee_id": 1,
          "network_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "account_status": "active"
        },
        "affiliate": {
          "network_affiliate_id": 10,
          "network_id": 1,
          "name": "Some Affiliate",
          "account_status": "active"
        },
        "affiliate_manager": {
          "network_employee_id": 1,
          "network_id": 1,
          "first_name": "John",
          "last_name": "Doe",
          "full_name": "John Doe",
          "account_status": "active"
        },
        "query_parameters": {},
        "attribution_method": "unknown",
        "usm_data": null
      },
      "network_offer_payout_revenue_id": 100
    }
  ]
}

Docs: Raw On Hold Conversions Report

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

The endpoints documented in this section allow you to pull on hold conversions and post-conversion events from the API. Each on hold conversion / event will be a “row” in the response as the data is not aggregated.

Note that currency conversion is not supported on raw on hold conversion endpoints. On hold conversions are always stored in the currency of the offer they belong to and this is how the endpoints return raw on hold conversions.

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

On Hold Conversion Report

POST /v1/networks/reporting/onhold

The on hold conversion report is the most flexible way to extract a list of on hold conversions and post-conversion events. It allows you to fetch a list of on hold conversions and post-conversion events while specifying filters to narrow down the scope of the set of data you are pulling.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A show_conversions boolean value that determines whether base conversions are returned (true / false)
A show_events boolean value that determines whether post-conversion events are returned (true / false)
The on_hold_status_filter used to filter on hold conversions based on their status. It can take the following values : on_hold, approved, rejected. It can be left empty if all on hold conversions need to be returned ("on_hold_status_filter": "").

Please note that the on hold conversion report is limited to the prior 365 days only. Requests outside of this range will result in an error.

Optional query filters can be added to the call

Paging

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

Query Filters

Query filters allow you to limit the scope of the report returned by the API. You could create a filter to limit the reporting data to a single offer for example. You can use multiple filters in a request.

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull on hold conversions for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, transaction_id, campaign, adv1, adv2, adv3, adv4, adv5, offer_creative, coupon_code, dma, date, isp, carrier, sub1, sub2, sub3, sub4, sub5, source_id, language, device_brand, month, browser, country, platform, region, device_type, offer_url, os_version, city, week, country_code

Examples

Here are a few variations of what you can pass as a payload in ithe following call :

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

Example 1 : Pull all on hold conversions (but no events) over a 1 hour period

{
    "from": "2022-02-08 13:00:00",
    "to": "2022-02-08 14:00:00",
    "timezone_id": 67,
    "show_conversions": true,
    "show_events": false,
    "on_hold_status_filter": "",
    "query":{
        "filters": []
    }
}

Example 2 : Pull pending on hold conversions and events on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "on_hold",
    "query":{
        "filters": [
            {
                "filter_id_value": "800",
                "resource_type": "offer"
            }
        ]
    }
}

Example 3 : Pull all on hold onversions and events that were generated from either of these 2 transaction IDs

{
    "from": "2022-02-01",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "on_hold_status_filter": "",
    "query":{
        "filters": [
            {
                "filter_id_value": "e33e03d630a04f499835cfa3d3158baf",
                "resource_type": "transaction_id"
            },
            {
                "filter_id_value": "2718b9f7adeb4d98869767bc1202edf5",
                "resource_type": "transaction_id"
            }
        ]
    }
}

Response

A response from the on hold conversion report endpoint will look like :

{
	"conversions": [
		{
			"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
            "network_id": 1,
            "holding_period_end": 1661980244,
            "status": "on_hold",
            "conversion": {
                "conversion_id": "",
                "conversion_unix_timestamp": 1643691617,
                "sub1": "inapp",
                "sub2": "external",
                "sub3": "",
                "sub4": "",
                "sub5": "facebook",
                "source_id": "1000",
                "status": "",
                "payout_type": "cpa",
                "revenue_type": "rpa",
                "payout": 0.8,
                "revenue": 1,
                "session_user_ip": "80.21.15.xxx",
                "conversion_user_ip": "1.2.3.4",
                "country": "Italy",
                "region": "Milano",
                "city": "Arluno",
                "dma": 0,
                "carrier": "",
                "platform": "iOS",
                "os_version": "10.3",
                "device_type": "Mobile",
                "device_model": "",
                "brand": "Apple",
                "browser": "Facebook for iOS",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
                "adv1": "",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "is_event": false,
                "event": "Example Event",
                "notes": "",
                "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
                "click_unix_timestamp": 1643691604,
                "error_code": 0,
                "error_message": "N/A",
                "sale_amount": 96,
                "is_scrub": false,
                "coupon_code": "",
                "order_id": "",
                "url": "",
                "isp": "telecom italia s.p.a.",
                "referer": "",
                "app_id": "",
                "idfa": "",
                "idfa_md5": "",
                "idfa_sha1": "",
                "google_ad_id": "",
                "google_ad_id_md5": "",
                "google_ad_id_sha1": "",
                "android_id": "",
                "android_id_md5": "",
                "android_id_sha1": "",
                "currency_id": "USD",
                "email": "",
                "is_view_through": false,
                "previous_network_offer_id": 0,
                "relationship": {
                    "offer": {
                        "network_offer_id": 882,
                        "network_id": 1,
                        "name": "Example Offer",
                        "offer_status": "active"
                    },
                    "advertiser": {
                        "network_advertiser_id": 135,
                        "network_id": 1,
                        "name": "Advertiser Inc."
                    },
                    "account_manager": {
                        "network_employee_id": 15,
                        "network_id": 1,
                        "first_name": "John",
                        "last_name": "Doe",
                        "full_name": "John Doe",
                        "account_status": "active"
                    },
                    "affiliate": {
                        "network_affiliate_id": 102,
                        "network_id": 1,
                        "name": "Affiliate Inc.",
                        "account_status": "active"
                    },
                    "affiliate_manager": {
                        "network_employee_id": 8,
                        "network_id": 1,
                        "first_name": "Jane",
                        "last_name": "Doe",
                        "full_name": "Jane Doe",
                        "account_status": "active"
                    },
                    "query_parameters": {},
                    "attribution_method": "cookie",
                    "usm_data": null
                },
                "network_offer_payout_revenue_id": 0
            }
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

On Hold Conversion Report Export

POST /v1/networks/reporting/onhold/export

The export endpoint is very similar to the report endpoint documented above but adds 2 possibilities :

It lets you “export” the data in CSV or JSON format
It optionally lets your specify the columns you want included in your report

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Examples

cURL

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

Example : Export approved on hold conversions on offer 800 in JSON format. Only include 5 specific columns.

{ "from": "2022-02-07", "to": "2022-02-10", "timezone_id": 80, "show_conversions": true, "show_events": true, "on_hold_status_filter": "approved", "query":{ "filters": [ { "filter_id_value": "800", "resource_type": "offer" } ] }, "columns": [ "on_hold_conversion_id", "offer", "affiliate", "transaction_id", "conversion_id" ], "format": "json"

}

On Hold Conversion By ID

GET /v1/networks/reporting/onhold/:onHoldId

Fetch a single on hold conversion by its unique on hold conversion ID.

Path Parameters

Parameter	Description
onHoldId	The ID of the on hold conversion (32 char)

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/reporting/onhold/<32 char On Hold Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"on_hold_conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
    "network_id": 1,
    "holding_period_end": 1661980244,
    "status": "on_hold",
    "conversion": {
        "conversion_id": "",
        "conversion_unix_timestamp": 1643691617,
        "sub1": "inapp",
        "sub2": "external",
        "sub3": "",
        "sub4": "",
        "sub5": "facebook",
        "source_id": "1000",
        "status": "",
        "payout_type": "cpa",
        "revenue_type": "rpa",
        "payout": 0.8,
        "revenue": 1,
        "session_user_ip": "80.21.15.xxx",
        "conversion_user_ip": "1.2.3.4",
        "country": "Italy",
        "region": "Milano",
        "city": "Arluno",
        "dma": 0,
        "carrier": "",
        "platform": "iOS",
        "os_version": "10.3",
        "device_type": "Mobile",
        "device_model": "",
        "brand": "Apple",
        "browser": "Facebook for iOS",
        "language": "en",
        "http_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_3 like Mac OS X) AppleWebKit/603.3.8 (KHTML, like Gecko) Mobile/14G60 [FBAN/FBIOS;FBAV/141.0.0.51.91;FBBV/71695290;FBDV/iPhone9,2;FBMD/iPhone;FBSN/iOS;FBSV/10.3.3;FBSS/3;FBCR/AT&T;FBID/phone;FBLC/es_LA;FBOP/5;FBRV/0]",
        "adv1": "",
        "adv2": "",
        "adv3": "",
        "adv4": "",
        "adv5": "",
        "is_event": false,
        "event": "Example Event",
        "notes": "",
        "transaction_id": "042760c2eee8473fb17eec59dfe9de75",
        "click_unix_timestamp": 1643691604,
        "error_code": 0,
        "error_message": "N/A",
        "sale_amount": 96,
        "is_scrub": false,
        "coupon_code": "",
        "order_id": "",
        "url": "",
        "isp": "telecom italia s.p.a.",
        "referer": "",
        "app_id": "",
        "idfa": "",
        "idfa_md5": "",
        "idfa_sha1": "",
        "google_ad_id": "",
        "google_ad_id_md5": "",
        "google_ad_id_sha1": "",
        "android_id": "",
        "android_id_md5": "",
        "android_id_sha1": "",
        "currency_id": "USD",
        "email": "",
        "is_view_through": false,
        "previous_network_offer_id": 0,
        "relationship": {
            "offer": {
                "network_offer_id": 882,
                "network_id": 1,
                "name": "Example Offer",
                "offer_status": "active"
            },
            "advertiser": {
                "network_advertiser_id": 135,
                "network_id": 1,
                "name": "Advertiser Inc."
            },
            "account_manager": {
                "network_employee_id": 15,
                "network_id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "full_name": "John Doe",
                "account_status": "active"
            },
            "affiliate": {
                "network_affiliate_id": 102,
                "network_id": 1,
                "name": "Affiliate Inc.",
                "account_status": "active"
            },
            "affiliate_manager": {
                "network_employee_id": 8,
                "network_id": 1,
                "first_name": "Jane",
                "last_name": "Doe",
                "full_name": "Jane Doe",
                "account_status": "active"
            },
            "query_parameters": {},
            "attribution_method": "cookie",
            "usm_data": null
        },
        "network_offer_payout_revenue_id": 0
    }
}

Docs: Raw Impressions Report

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

Are you looking to fetch all your impressions? If so, the Firehose might be suited for your use case.

Impression

POST /v1/networks/reporting/impressions/stream

Only be available to customers who have the impression package.

This endpoint is used to extract a raw list of impressions. In the result of this request each impression will be one element / row. To avoid extremely slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of impressions that can be returned by this endpoint is : 10 000. If there are more than 10 000 impressions that match the request, they will not be returned.

Requests are only allowed for a period of 14 days of less. Requesting a longer period will result in an error (400 bad request).

While the impressions analytics are kept forever, the raw data used to create the response on this endpoint is only kept for a period of 3 months on the Everflow servers. Requests for time intervals that go beyond that period will not return impressions.

This endpoint should not be used to extract every impression from the platform. Requests to extracts large lists of impressions should be made via the Request Report feature.

Each request must contain :

from and to dates in YYYY-mm-DD HH:MM:SS format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull reporting data for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values :

offer, offer_group, affiliate, advertiser, creative, network, account_manager, affiliate_manager, category, billing_frequency, country, region, city, dma, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, business_unit, label, sales_manager, account_executive, everflow_account_manager, os_version, project_id, isp, offer_status, sub1, sub2, sub3, sub4, sub5, channel, coupon_code, affiliate_tier

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/impressions/stream \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example Pull impressions over a 30 minutes period on 2 specific offers

{
    "from": "2022-02-01 12:30:00",
    "to": "2022-02-01 13:00:00",
    "timezone_id": 90,
    "query":
    {
        "filters":
        [
            {
                "filter_id_value": "882",
                "resource_type": "offer"
            },
            {
                "filter_id_value": "883",
                "resource_type": "offer"
            }
        ]
    }
}

Docs: Event Report

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

Event

POST /v1/networks/reporting/postconversions

This endpoint allows the performance reporting to be broken down into events in addition to up to 2 other column types.

Each request must contain :

from and to dates (format can be YYYY-mm-DD or YYYY-mm-DD hh:mm:ss)
The timezone_id used for the request. Find all timezones here
A pivot column that will either be event_name or advertiser_event_name depending on the events you are interested in
One or two columns to break down the data

Requested intervals are limited to a maximum duration of one year. For example, requests with "from": "2022-01-01", "to": "2023-12-31" are considered invalid and will return an error.

Optional query filters can be added to the call.

The columns you request to break down the data will be one or two of the following :

offer, offer_id, offer_group, offer_group_id, creative, creative_id, category, campaign, campaign_id, offer_url, project_id, affiliate, affiliate_id, affiliate_manager, advertiser, advertiser_id, account_manager, sales_manager, account_executive, country, region, city, dma, isp, carrier, connection_type, platform, os_version, device_type, browser, device_make, language, device_model, source_id, referer, sub1, sub2, sub3, sub4, sub5

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "518",
          "resource_type": "offer"
      },
      {
          "filter_id_value": "United States",
          "resource_type": "country"
      }
    ]
  }
}

translate to “Pull events for US traffic on offer 883 OR offer 518”.

Filter Resource Types

The resource-type used in the query filters can take the following values :

offer, offer_group, affiliate, advertiser, offer_creative, affiliate_tier, campaign, billing_frequency, business_unit, tracking_domain

Request Example

cURL

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

Request

{
  "from": "2022-02-10",
  "to": "2022-02-10",
  "timezone_id": 67,
  "columns": [
    {
      "column": "offer"
    },
    {
      "column": "affiliate"
    },
    {
      "column": "event_name"
    }
  ],
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      }
    ]
  }
}

Docs: Data Supplements

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

The endpoints documented in this section allow you to fetch and manipulate data supplements via the API.

You can learn more about learn more about what data supplements are at the following link: https://helpdesk.everflow.io/customer/data-supplement

Fetch Data Supplements

This endpoint retrieves a structured table of Data Supplements, which represent manual or automated (via integrations) reporting adjustments applied to your network data. Supplements are typically used to correct discrepancies, reconcile billing, or inject offline data into your aggregated reporting statistics.

POST /v1/networks/supplements/table

Optional query filters can be added to the call

Paging

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

Query Filters

{
  "query": {
    "filters": {
      "network_affiliate_ids": [
        10
      ],
      "network_offer_ids": [
        1,
        2
      ],
      "source_ids": [],
      "supplement_source": "generic"
    },
    //...
  }
}

translates to “Pull data supplements associated to offer_id 1 OR offer_id 2 AND network_affiliate_id 10 AND from the supplement_source of Generic”.

In addition to these filters json source details can be queried for as well

{
  "query": {
    //...,
    "search_terms": [
      {
        "search_type": "json_text",
        "value": "Manual: 1"
      }
    ]
  }
}

The above query will look for data supplements with a “source_details_json” value of “manual”: 1.

Body Params

from string

Date from which you want to pull data supplements from. In the format “YYYY-MM-DD”

to string

Date to which you want to pull data supplements from. In the format “YYYY-MM-DD”

timezone_id int

Timezone from which you would like your interval to be pulled from

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/table' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Payload

{
	"to": "2026-02-10",
	"from": "2026-02-01",
	"timezone_id": 80,
	"query": {
		"filters": {
			"network_affiliate_ids": [],
			"network_offer_ids": [],
			"source_ids": []
		},
		"search_terms": [
          {
          "search_type": "json_text",
          "value": "parameter1: 1"
          }
        ]
	}
}

Response

{
  "network_data_supplement_id": 1,
  "network_id": 5,
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "currency_id": "USD",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "ctr": 2.333,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "total_cv": 16,
    "event": 5,
    "cvr": 4.571,
    "evr": 31.25,
    "cpc": 0.429,
    "cpm": 10,
    "cpa": 9.375,
    "epc": 0.286,
    "rpc": 0.714,
    "rpa": 15.625,
    "rpm": 16.667,
    "payout": 150,
    "revenue": 250,
    "event_revenue": 50,
    "gross_sales": 500,
    "profit": 100,
    "margin": 40,
    "roas": 2,
    "avg_sale_value": 31.25,
    "media_buying_cost": 120,
    "on_hold_potential_revenue": 0,
    "on_hold_potential_payout": 0,
    "on_hold_conversion_count": 0,
    "public_events": 0
  },
  "network_offer_payout_revenue_id": 0,
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "time_created": 1770766284
}

Export Data Supplements

This endpoint behaves similarly to the endpoint above with 2 caveats:

This endpoint doesn’t deal with paging so will return all data supplements from the query
The data returned from this endpoint will be formatted in either csv or json.

This endpoint takes all the fields from the endpoint listed above with the addition of a format field which will either be csv or json.

POST /v1/networks/supplements/table/stream

Examples

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/table/stream' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Example : Pull all data supplements associated with offer_id 1 and affiliate_id 10 in JSON format.

{
  "format": "json",
  "from": "2026-01-11",
  "query": {
    "filters": {
      "network_affiliate_ids": [
        10
      ],
      "network_offer_ids": [
        1
      ],
      "source_ids": []
    },
    "search_terms": []
  },
  "timezone_id": 80,
  "to": "2026-02-11"
}

Create Data supplements

This endpoint allows you to programmatically inject/ create reporting adjustments into your network’s data.

POST /v1/networks/supplements

Body Params

unix_timestamp int

The timestamp in which you would like the data to be placed in your reporting

supplement_source string

This tells us what source this data supplement is coming from. The allowed value to be coming form the API is “generic”.

source_details_json object

This field will take a json object used to give more context surrounding the data supplement being added. If left empty or emitted will be given the value {}.

network_offer_id int

The Id of the offer you would like this data supplement to be applied to.

network_affiliate_id string

The Id of the affiliate you would like this data supplement to be applied to.

source_id string

The source_id that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub1 string

The sub1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub2 string

The sub2 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub3 string

The sub3 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub4 string

The sub4 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

sub5 string

The sub5 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv1 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv2 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv3 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv4 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

adv5 string

The adv1 that will be associated to the data supplement being created. If left empty or emitted will be given the value “".

reporting object

View Object Details Hide Object Details

imp int

The impression data to be added in reporting. If left empty or emitted will be given the value 0.

total_clicks int

The total_clicks to be added in reporting. If left empty or emitted will be given the value 0.

unique_clicks int

The unique_click total to be added in reporting. If left empty or emitted will be given the value 0.

invalid_click int

The invalid_click total to be added in reporting. If left empty or emitted will be given the value 0.

duplicate_click int

The duplicate_click total to be added in reporting. If left empty or emitted will be given the value 0.

gross_click int

The gross_click total to be added in reporting. If left empty or emitted will be given the value 0.

cv int

The conversion total to be added in reporting. If left empty or emitted will be given the value 0.

invalid_cv_scrub int

The conversion total that was scrubbed/throttled to be added in reporting. If left empty or emitted will be given the value 0.

view_through_cv int

The conversion total that came from view-through traffic to be added in reporting. If left empty or emitted will be given the value 0.

event int

The events total to be added in reporting. If left empty or emitted will be given the value 0.

public_events int

The public_events total to be added in reporting, this won’t be displayed back into the response but is recorded in reporting. If left empty or emitted will be given the value 0.

payout int

The payout total to be added in reporting. If left empty or emitted will be given the value 0.

revenue int

The revenue total to be added in reporting. If left empty or emitted will be given the value 0.

event_revenue int

The event_revenue total to be added in reporting. If left empty or emitted will be given the value 0.

gross_sales int

The gross_sale total to be added in reporting. If left empty or emitted will be given the value 0.

media_buying_cost int

The the media buying spend total to be added in reporting. If left empty or emitted will be given the value 0.

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

{
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "currency_id": "USD",
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "event": 5,
    "public_events": 4,
    "payout": 150.00,
    "revenue": 200.00,
    "event_revenue": 50.00,
    "gross_sales": 500.00,
    "media_buying_cost": 120.00
  }
}

Response

{
  "network_data_supplement_id": 1,
  "network_id": 5,
  "unix_timestamp": 1768032000,
  "supplement_source": "generic",
  "network_offer_id": 1,
  "network_affiliate_id": 10,
  "source_id": "source_id",
  "sub1": "sub1",
  "sub2": "sub2",
  "sub3": "sub3",
  "sub4": "sub4",
  "sub5": "sub5",
  "adv1": "adv1",
  "adv2": "adv2",
  "adv3": "adv3",
  "adv4": "adv4",
  "adv5": "adv5",
  "currency_id": "USD",
  "reporting": {
    "imp": 15000,
    "total_click": 350,
    "unique_click": 300,
    "invalid_click": 10,
    "duplicate_click": 40,
    "gross_click": 350,
    "ctr": 2.333,
    "cv": 15,
    "invalid_cv_scrub": 0,
    "view_through_cv": 1,
    "total_cv": 16,
    "event": 5,
    "cvr": 4.571,
    "evr": 31.25,
    "cpc": 0.429,
    "cpm": 10,
    "cpa": 9.375,
    "epc": 0.286,
    "rpc": 0.714,
    "rpa": 15.625,
    "rpm": 16.667,
    "payout": 150,
    "revenue": 250,
    "event_revenue": 50,
    "gross_sales": 500,
    "profit": 100,
    "margin": 40,
    "roas": 2,
    "avg_sale_value": 31.25,
    "media_buying_cost": 120,
    "on_hold_potential_revenue": 0,
    "on_hold_potential_payout": 0,
    "on_hold_conversion_count": 0,
    "public_events": 0
  },
  "network_offer_payout_revenue_id": 0,
  "source_details_json": "{\"parameter1\": 1, \"parameter2\": 2}",
  "time_created": 1770766284
}

Revert Data Supplements

This endpoint allows you to undo or negate previously applied reporting adjustments. By triggering a reversal, you ensure that specific data supplements are removed from your reporting aggregates, effectively restoring the data to its state prior to the adjustment.

POST /v1/networks/supplements/revert

Request Example

cURL

curl --request GET 'https://api.eflow.team/v1/networks/supplements/revert' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \

Example Payload

{
  "data_supplement_ids": [
    1,
    2,
    3,
    ...
  ]
}

Response

{
	"result": true
}

Docs: Affiliate Postback

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

In the endpoints documented here, each affiliate postback is a “row” in the response. The data is not aggregated.

Affiliate Postback Report

POST /v1/networks/reporting/affiliate/pixels

This endpoint is used to extract a affiliate postbacks. In the result of this request, each postback will be one element / row. To avoid slow response times and limit the size of the payload, this endpoint is limited in what it actually returns.

The maximum number of postbacks that can be returned by this endpoint is : 1000. If there are more than 1000 postbacks for the period / filters requested, they will not be returned. Please use the export streaming endpoint documented below which doesn’t have the same restriction.

Each request must contain :

from and to dates in either the YYYY-mm-DD HH:MM:SS or the YYYY-mm-DD format
timezone_id used for the request. Find all timezones here

but can also contain optional query filters.

Query Filters

Filters that apply to the same resource_type will act as OR operator. Different resource_type work with an AND operator. The following filters :

{
  //...
	"query": {
		"filters":[
			{
				"resource_type": "offer",
				"filter_id_value": "15"
			},
			{
				"resource_type": "offer",
				"filter_id_value": "18"
			},
			{
				"resource_type": "affiliate",
				"filter_id_value": "7"
			}
		]
	}
}

translate to “Pull all postback data for affiliate 7 on offers 15 and 18”.

Filter Resource Types

The resource-type used in the filters and exclusions can take the following values : offer, affiliate and delivery_status

The delivery_status can either be success or failure

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/networks/reporting/affiliate/pixels \
  --header 'content-type: application/json' \
  --header 'X-Eflow-API-Key: <INSERT API KEY>' \
  --data '<INSERT PAYLOAD>'

Example 1 : Include postbacks for offer ID 11 that succeeded

{
  "timezone_id": 90,
  "from": "2024-02-07",
  "to": "2024-02-08",
  "query":{
    "filters": [
     {
        "resource_type": "offer",
        "filter_id_value": "11"
      },
      {
        "resource_type": "delivery_status",
        "filter_id_value": "success"
      }
    ]
  }
}

Response

{
  "pixels": [
    {
      "network_id": 1,
      "network_offer_id": 11,
      "network_offer_payout_revenue_id": 0,
      "affiliate_id": 7,
      "pixel_id": 132,
      "conversion_id": "a3371dd7b36849cbbfdd9c300b06fdb5",
      "transaction_id": "d5c6feef0d8f489fb91aa5cfb4d64f4e",
      "timestamp": 1707425899,
      "delivery_method": "postback",
      "pixel_level": "global",
      "pixel_status": "active",
      "pixel_type": "conversion",
      "payload": "https://httpbin.org/get?tid=d5c6feef0d8f489fb91aa5cfb4d64f4e",
      "is_success": true,
      "debug_information": "PostbackUrl: https://httpbin.org/get?tid=d5c6feef0d8f489fb91aa5cfb4d64f4e\nStatus: 200\nScheme: \nPath: \nAuthority: \nHeaders: Server: [gunicorn/19.9.0]",
      "last_attempt": 0,
      "failed_attempts": 0,
      "relationship": {
        "offer": {
          "network_offer_id": 11,
          "network_id": 1,
          "network_advertiser_id": 13,
          "network_offer_group_id": 0,
          "name": "Example Offer",
          "offer_status": "active",
          "network_tracking_domain_id": 134,
          "visibility": "public",
          "currency_id": "USD"
        },
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "John Doe Inc.",
          "account_status": "active",
          "network_traffic_source_id": 0
        }
      }  
    }
  ]
}

Affiliate Postback Export

POST /v1/networks/reporting/affiliate/pixels/export

The table export is basically identical to the endpoint documented above, except that it lets you “export” the data in CSV or JSON format and doesn’t limit you to 1000 postbacks.

Please note that when using the JSON format, the results will be newlined delimited JSON.

You must add the format properly to the payloads from the regular table endpoint for requests to work on this endpoint. The format can be either :

csv
json

Example

curl --request POST 'https://api.eflow.team/v1/networks/reporting/affiliate/pixels/export' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "timezone_id": 90,
  "from": "2024-02-07",
  "to": "2024-02-08",
  "query":{
    "filters": [
     {
        "resource_type": "offer",
        "filter_id_value": "11"
      },
      {
        "resource_type": "delivery_status",
        "filter_id_value": "success"
      }
    ]
  },
  "format": "csv"
}'

Docs: Firehose: Real-Time Event Streaming

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

The Everflow API lets you fetch unaggregated reporting data through the endpoints documented in this section. More specifically :

Raw Clicks endpoints allow you to fetch unaggregated click data
Raw Impressions endpoints allow you to fetch unaggregated impression data
Raw Conversions endpoints allow you to fetch unaggregated conversion / event data

The Firehose, on the other hand, is a real-time data streaming solution that enables networks to receive their tracking events (clicks, impressions, and conversions) directly into their own infrastructure as they occur. This solution is particularly valuable for networks requiring a complete copy of their data without the constraints of traditional API polling.

Overview

While Everflow’s REST API provides comprehensive access to your data, the Firehose offers distinct advantages for specific use cases:

Real-time data delivery (typically sub-second latency)
No rate limiting
Direct integration with your infrastructure
Automatic handling of conversion updates
Elimination of duplicate data concerns associated with time intervals

Supported Platforms

The Firehose currently supports streaming to:

Amazon SQS
Google Cloud Pub/Sub
Standard HTTPS POST calls

Additional cloud providers, such as Azure, or other streaming methods, can be supported upon request.

How It Works

Tracking events occur on your Everflow instance (clicks, impressions, conversions and conversion updates)
Events are immediately processed and streamed to your designated message queue
Your applications can store or consume these events in real-time from your message queue

The firehose publishes on your message queue

Customization Options

The Firehose implementation is customizable per network:

Configurable payload structure
Include all raw query parameters from tracking events
Custom field mapping and data transformations
Filtering options for specific event types – you can decide to receive only a subset of your data

Here are examples of the payloads we can send for the different types of events : click, impression, conversion and conversion update.

Key Benefits

The Firehose addresses several limitations of traditional API-based data retrieval:

No Rate Limits: All events are guaranteed to be delivered, regardless of volume
Real-Time Processing: Eliminate the need for polling intervals and complex scheduling
Conversion Updates: Automatically receive updates to conversion data as they occur without having to fetch past intervals
Configurable Payload: Get the payload that works for your use case
Data Consistency: Avoid challenges with time-based querying and potential data gaps
Security: Secure authentication with your cloud infrastructure, encrypted data transmission

Implementation Process

To implement the Firehose for your network:

Contact Everflow Support to initiate Firehose setup
Provide your cloud infrastructure details (e.g., Google Cloud Pub/Sub topic or Amazon SQS queue)
Work with our team to configure payload structure and any custom requirements
Receive implementation documentation specific to your configuration
Begin receiving real-time event data

Please contact Everflow Support to get started. Our team will work with you to determine the best configuration for your needs and guide you through the implementation process.