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 "country" would mean that each reporting “line” is a unique couple of offer / country.

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
creative	Group by creative id
coupon_code	Group by coupon code
offer_url	Group by offer url
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
isp	Group by isp
os_version	Group by OS version
device_type	Group by device type
device_model	Group by device model
device_make	Group by device make
browser	Group by browser
language	Group by language
sub1	Group by sub1 (same for sub2-5)
source_id	Group by source id
referer	Group by referer
event_name	Group by event name
connection_type	Group by connection type
tracking_domain	Group by tracking domain
hour	Group by hour
date	Group by date
week	Group by week
month	Group by month
year	Group by year

Table

POST /v1/affiliates/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”.

Filter Resource Types

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

offer, creative, country, country_code, sub1, sub2, sub3, sub4, sub5, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, os_version, coupon_code

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/affiliates/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

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

Example 2 : Pull all reporting data for the 8th of February 2022 (from midnight until 23h59:59) for offer IDs 882 and 883

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

Example 3 : 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 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":
    {
<span style="color:#000;font-weight:bold">}</span>

}

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.

Given the following request payload :

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

The response would look like :

{
	"table": [
		{
			"columns": [
				{
					"column_type": "offer",
					"id": "3",
					"label": "Example Offer Name"
				},
				{
					"column_type": "country",
					"id": "United States",
					"label": "United States"
				}
			],
			"reporting": {
				"imp": 0,
				"total_click": 27,
				"unique_click": 27,
				"invalid_click": 0,
				"duplicate_click": 0,
				"ctr": 0,
				"cv": 2,
				"view_through_cv": 0,
				"event": 0,
				"cvr": 7.407,
				"evr": 0,
				"rpc": 0.059,
				"rpm": 0,
				"revenue": 1.6,
				"redirect_traffic_revenue": 0
			}
		},
		{
			"columns": [
				{
					"column_type": "offer",
					"id": "3",
					"label": "Example Offer"
				},
				{
					"column_type": "country",
					"id": "Canada",
					"label": "Canada"
				}
			],
			"reporting": {
				"imp": 0,
				"total_click": 10,
				"unique_click": 10,
				"invalid_click": 0,
				"duplicate_click": 0,
				"ctr": 0,
				"cv": 2,
				"view_through_cv": 0,
				"event": 0,
				"cvr": 20,
				"evr": 0,
				"rpc": 0.16,
				"rpm": 0,
				"revenue": 1.6,
				"redirect_traffic_revenue": 0
			}
		}
	]
}

Table Export

POST /v1/affiliates/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/affiliates/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": "country"
        }
    ],
    "query": {
        "filters": [ ]
    },
    "format": "csv"
}'

Docs: Dashboard Stats

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

Dashboard Summary

POST /v1/affiliates/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.

The endpoint takes a single parameter in the request body : a timezone id. Find all timezones here

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/affiliates/dashboard/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "timezone_id": 80
  }'

Response

{
    "revenue": {
        "today": 4,
        "yesterday": 5.6,
        "current_month": 23.20,
        "last_month": 0,
        "trending_percentage": -28.6
    },
    "click": {
        "today": 46,
        "yesterday": 9,
        "current_month": 74,
        "last_month": 0,
        "trending_percentage": 411.1
    },
    "conversion": {
        "today": 5,
        "yesterday": 7,
        "current_month": 29,
        "last_month": 0,
        "trending_percentage": -28.6
    },
    "cvr": {
        "today": 10.87,
        "yesterday": 77.778,
        "current_month": 39.189,
        "last_month": 0
    },
    "events": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "evr": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0
    },
    "redirect_revenue": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    },
    "impression": {
        "today": 0,
        "yesterday": 0,
        "current_month": 0,
        "last_month": 0,
        "trending_percentage": 0
    }
}

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.

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/affiliates/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 : 5000. If there are more than 5000 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.

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, creative, country, carrier, device_platform, device_type, device_make, browser, language, connection_type, campaign, source_id, offer_url, device_model, s1, s2, s3, s4, s5, coupon_code

Request Example

cURL

curl --request POST \
  --url https://api.eflow.team/v1/affiliates/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 : All clicks 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": "410da86457f54ae388a871d54a33275b",
      "is_unique": 1,
      "unix_timestamp": 1702313995,
      "tracking_url": "www.tracking-link.com",
      "source_id": "",
      "sub1": "facebook",
      "sub2": "",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "revenue_type": "CPA",
      "revenue": 0,
      "referer": "",
      "error_code": 0,
      "user_ip": "127.0.0.1",
      "error_message": "N/A",
      "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",
      "coupon_code": "SUMMER",
      "relationship": {
        "offer": {
          "network_offer_id": 1,
          "network_id": 1,
          "name": "Example Offer",
          "offer_status": "active",
          "network_tracking_domain_id": 1
        },
        "geolocation": {
          "country_code": "US",
          "country_name": "United States",
          "region_code": "",
          "region_name": "California",
          "city_name": "Burbank",
          "dma": 803,
          "dma_name": "Los Angeles, CA",
          "timezone": "America/Los_Angeles",
          "carrier_name": "T-Mobile USA",
          "carrier_code": 0,
          "organization": "",
          "isp_name": "T-mobile Usa Inc.",
          "is_mobile": false,
          "is_proxy": false,
          "postal_code": ""
        },
        "device_information": {
          "is_mobile": true,
          "platform_name": "macOS",
          "os_version": "",
          "brand": "Apple",
          "model": "",
          "is_tablet": false,
          "browser_name": "Safari",
          "browser_version": "",
          "device_type": "PC",
          "language": "fr",
          "http_accept_language": "",
          "is_robot": false,
          "is_filter": false
        },
        "query_parameters": {
          "__cc": "SUMMER"
        }
      }
    }
  ]
}

Click By ID

GET /v1/affiliates/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/affiliates/reporting/clicks/<32 char Transaction ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
  "transaction_id": "d746e9ab66914764b6a0cf6ab25d0cdf",
  "is_unique": 1,
  "unix_timestamp": 1661970238,
  "tracking_url": "www.tracking-domain.test",
  "source_id": "",
  "sub1": "internal",
  "sub2": "",
  "sub3": "facebook",
  "sub4": "",
  "sub5": "",
  "revenue_type": "CPA",
  "revenue": 0,
  "referer": "",
  "error_code": 0,
  "user_ip": "68.26.161.189",
  "error_message": "N/A",
  "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",
  "coupon_code": "SUMMER",
  "relationship": {
    "offer": {
      "network_offer_id": 3,
      "network_id": 1,
      "name": "Example Offer Name",
      "offer_status": "active",
      "network_tracking_domain_id": 1
    },
    "geolocation": {
      "country_code": "US",
      "country_name": "United States",
      "region_code": "",
      "region_name": "California",
      "city_name": "Burbank",
      "dma": 803,
      "dma_name": "Los Angeles, CA",
      "timezone": "America/Los_Angeles",
      "carrier_name": "T-Mobile USA",
      "carrier_code": 0,
      "organization": "",
      "isp_name": "T-mobile Usa Inc.",
      "is_mobile": false,
      "is_proxy": false,
      "postal_code": ""
    },
    "device_information": {
      "is_mobile": true,
      "platform_name": "macOS",
      "os_version": "",
      "brand": "Apple",
      "model": "",
      "is_tablet": false,
      "browser_name": "Safari",
      "browser_version": "",
      "device_type": "PC",
      "language": "fr",
      "http_accept_language": "",
      "is_robot": false,
      "is_filter": false
    },
    "query_parameters": {
      "__cc": "SUMMER"
    }
  }
}

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.

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.

Conversion Report

POST /v1/affiliates/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.

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. 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_creative, transaction_id, campaign, sub1, sub2, sub3, sub4, sub5, source_id, country, offer_url, browser, carrier, coupon_code, dma, device_brand, device_type, language, os_version, platform, region

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

Example 1 : Pull all 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,
    "query":{
        "filters": []
    }
}

Example 2 : Pull conversions and events on offer ID 800

{
    "from": "2022-02-07",
    "to": "2022-02-10",
    "timezone_id": 80,
    "show_conversions": true,
    "show_events": true,
    "query":{
        "filters": [
            {
                "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"
            }
        ]
    }
}

Response

A response from the conversion report endpoint will look like :

{
	"conversions": [
		{
			"conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
			"conversion_unix_timestamp": 1661970244,
			"sub1": "internal",
			"sub2": "",
			"sub3": "facebook",
			"sub4": "",
			"sub5": "",
			"source_id": "",
			"revenue_type": "CPA",
			"revenue": 0.8,
			"session_user_ip": "217.66.156.135",
			"conversion_user_ip": "",
			"country": "Russia",
			"region": "Sankt-peterburg",
			"city": "St Petersburg",
			"dma": 0,
			"carrier": "MTS Russia",
			"platform": "macOS",
			"os_version": "",
			"device_type": "PC",
			"brand": "Apple",
			"browser": "Safari",
			"language": "en",
			"http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
			"is_event": false,
			"event": "",
			"transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
			"click_unix_timestamp": 1661970238,
			"isp": "mts ojsc",
			"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",
			"is_view_through": false,
			"order_id": "",
			"adv1": "facebook",
			"adv2": "",
			"adv3": "",
			"adv4": "",
			"adv5": "",
			"relationship": {
				"offer": {
					"network_offer_id": 3,
					"network_id": 1,
					"name": "Daily Car",
					"offer_status": "active",
					"network_tracking_domain_id": 1
				},
                "events_count": 0,
                "offer_url": {
                    "network_offer_url_id": 100,
                    "network_id": 1,
                    "network_offer_id": 3,
                    "name": "Alternate Offer URL",
                    "preview_url": "https://example-shop.com"
                }
			}
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

Conversion Report Export

POST /v1/affiliates/reporting/conversions/export

The export endpoint is very similar to the report endpoint documented above but lets you export 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

Examples

cURL

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

Example : Export conversions and events on offer 800 in JSON format

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

Conversion By ID

GET /v1/affiliates/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/affiliates/reporting/conversions/<32 char Conversion ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Response

{
	"conversion_id": "f9d3fa7e86d241afbec4a6c6c3fe2580",
	"conversion_unix_timestamp": 1661970244,
	"sub1": "facebook",
	"sub2": "",
	"sub3": "internal",
	"sub4": "",
	"sub5": "",
	"source_id": "",
	"revenue_type": "CPA",
	"revenue": 0.8,
	"session_user_ip": "217.66.156.135",
	"conversion_user_ip": "",
	"country": "Russia",
	"region": "Sankt-peterburg",
	"city": "St Petersburg",
	"dma": 0,
	"carrier": "MTS Russia",
	"platform": "macOS",
	"os_version": "",
	"device_type": "PC",
	"brand": "Apple",
	"browser": "Safari",
	"language": "en",
	"http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
	"is_event": false,
	"event": "",
	"transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
	"click_unix_timestamp": 1661970238,
	"isp": "mts ojsc",
	"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",
	"is_view_through": false,
	"order_id": "",
	"adv1": "",
	"adv2": "",
	"adv3": "",
	"adv4": "",
	"adv5": "",
	"relationship": {
		"offer": {
			"network_offer_id": 3,
			"network_id": 1,
			"name": "Daily Car",
			"offer_status": "active",
			"network_tracking_domain_id": 1
		},
		"events_count": 0
	},
	"sale_amount": 0,
	"coupon_code": "SUMMER"
}

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/affiliates/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/affiliates/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": 1661970244,
                "sub1": "internal",
                "sub2": "",
                "sub3": "facebook",
                "sub4": "",
                "sub5": "",
                "source_id": "",
                "revenue_type": "CPA",
                "revenue": 0.8,
                "session_user_ip": "217.66.156.135",
                "conversion_user_ip": "",
                "country": "Russia",
                "region": "Sankt-peterburg",
                "city": "St Petersburg",
                "dma": 0,
                "carrier": "MTS Russia",
                "platform": "macOS",
                "os_version": "",
                "device_type": "PC",
                "brand": "Apple",
                "browser": "Safari",
                "language": "en",
                "http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
                "is_event": false,
                "event": "",
                "transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
                "click_unix_timestamp": 1661970238,
                "isp": "mts ojsc",
                "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",
                "is_view_through": false,
                "order_id": "",
                "adv1": "facebook",
                "adv2": "",
                "adv3": "",
                "adv4": "",
                "adv5": "",
                "relationship": {
                    "offer": {
                        "network_offer_id": 3,
                        "network_id": 1,
                        "name": "Daily Car",
                        "offer_status": "active",
                        "network_tracking_domain_id": 1
                    },
                    "events_count": 0,
                    "offer_url": {
                        "network_offer_url_id": 100,
                        "network_id": 1,
                        "network_offer_id": 3,
                        "name": "Alternate Offer URL",
                        "preview_url": "https://example-shop.com"
                    }
                }
            }
		},
		// ...
	],
	"paging": {
		"page": 1,
		"page_size": 2000,
		"total_count": 2
	}
}

On Hold Conversion By ID

GET /v1/affiliates/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/affiliates/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": 1661970244,
        "sub1": "internal",
        "sub2": "",
        "sub3": "facebook",
        "sub4": "",
        "sub5": "",
        "source_id": "",
        "revenue_type": "CPA",
        "revenue": 0.8,
        "session_user_ip": "217.66.156.135",
        "conversion_user_ip": "",
        "country": "Russia",
        "region": "Sankt-peterburg",
        "city": "St Petersburg",
        "dma": 0,
        "carrier": "MTS Russia",
        "platform": "macOS",
        "os_version": "",
        "device_type": "PC",
        "brand": "Apple",
        "browser": "Safari",
        "language": "en",
        "http_user_agent": "Mozilla/5.0 (Macintosh; U; PPC Mac OS X 10_7_2 rv:5.0) Gecko/20111121 Firefox/5.0.1",
        "is_event": false,
        "event": "",
        "transaction_id": "a22f8a1b5fde4801a2ed3dceabf4f8a3",
        "click_unix_timestamp": 1661970238,
        "isp": "mts ojsc",
        "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",
        "is_view_through": false,
        "order_id": "",
        "adv1": "facebook",
        "adv2": "",
        "adv3": "",
        "adv4": "",
        "adv5": "",
        "relationship": {
            "offer": {
                "network_offer_id": 3,
                "network_id": 1,
                "name": "Daily Car",
                "offer_status": "active",
                "network_tracking_domain_id": 1
            },
            "events_count": 0,
            "offer_url": {
                "network_offer_url_id": 100,
                "network_id": 1,
                "network_offer_id": 3,
                "name": "Alternate Offer URL",
                "preview_url": "https://example-shop.com"
            }
        }
    }
}