Raw Clicks Report
Operations to fetch raw clicks
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/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 :
fromandtodates inYYYY-mm-DD HH:MM:SSformattimezone_idused for the request. Find all timezones here
but can also contain optional query filters.
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, 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": ""
}