Reporting

Operations for reporting

Entity

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

Access a custom reporting based on one or up to 10 column types. Column selection is mandatory for this endpoint and allowed values are listed below. Filters, settings and metric filters can be used to narrow down the search.

This endpoint allows grouping by categories and subcategories. For example, to get a report that details performance for every affiliate, select column affiliate. To get a more precise understanding of affiliate performance by offer, select columns offer and affiliate. This will generate reporting for every offer-affiliate combination. Can be used in combination with filters.

This endpoint outputs these 3 distinct objects :

Table : This object is the reporting itself split in desired categories (limit to 10,000 rows)
Performance : Breaks the result into timestamp division. Useful to print a graph of the performance relative to time.
Summary : Aggregates the result of each metric into one value for the time period.

Please note that the table portion is limited to 10,000 rows. If you hit the limit, response will include "incomplete_results": true in the payload.

Columns

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
unix_timestamp	Group by unix timestamp
event_name	Group by event id
offer_url	Group by offer url id
country	Group by country
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

Return type (format) are either “csv” or “json”

Request Example

cURL

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

Request

{
    "query": {
        "filters": [],
        "exclusions": [],
        "metric_filters": [],
        "settings": {
            "ignore_fail_traffic": false
        }
    },
    "columns": [
        {
            "column": "offer"
        },
        {
            "column": "affiliate"
        }
    ],
    "from": "2020-11-16",
    "to": "2020-11-17",
    "timezone_id": 90,
    "currency_id": "USD",
    "format": "csv"
}

Conversion

POST /v1/networks/reporting/conversions/export

This endpoint is used to extract a raw list of conversions. In the response, each conversion will be one element / row.

Format is either "csv" or "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

Request Example

cURL

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

Request

{
    "show_conversions": true,
    "show_events": true,
    "show_only_scrub": false,
    "show_only_vt": false,
    "show_only_ct": false,
    "from": "2020-11-16",
    "to": "2020-11-17",
    "timezone_id": 90,
    "currency_id": "USD",
    "query": {
        "filters": [
            {
                "resource_type": "offer",
                "filter_id_value": "24"
            }
        ]
    },
    "show_only_fail_traffic": false,
    "format": "json",
    "columns": [
        "offer", "affiliate", "transaction_id", "conversion_id"
    ]
}

Response

{
    "conversion_id": "1816ebb21d674c7da089020b485a8d8c",
    "transaction_id": "b35dc35c6c804a808782dbecd1e59b04",
    "date": "2020-11-12 07:16:40",
    "click_date": "2020-11-12 07:16:11",
    "delta_hours": "0.01",
    "network_id": "1",
    "network_affiliate_id": "7",
    "network_affiliate_name": "Example Affiliate",
    "network_offer_id": "24",
    "network_offer_name": "Example Offer",
    "network_offer_group_id": "1",
    "network_offer_group_name": "Offer Group Name",
    "network_campaign_id": "",
    "network_campaign_name": "",
    "affiliate_manager_id": "2",
    "affiliate_manager_name": "Bob Smith",
    "network_advertiser_id": "13",
    "network_advertiser_name": "Advertiser Example",
    "account_manager_id": "2",
    "account_manager_name": "John Doe",
    "network_offer_creative_id": "0",
    "category_id": "1",
    "category_name": "Finance",
    "previous_network_offer_id": "",
    "previous_network_offer_name": "",
    "network_offer_payout_revenue_id": "151",
    "source_id": "",
    "sub1": "",
    "sub2": "",
    "sub3": "",
    "sub4": "",
    "sub5": "",
    "adv1": "",
    "adv2": "",
    "adv3": "",
    "adv4": "",
    "adv5": "",
    "session_user_ip": "127.0.0.1",
    "conversion_user_ip": "127.0.0.1",
    "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",
    "project_id": "",
    "payout_type": "CPA",
    "revenue_type": "RPA",
    "country": "",
    "region": "",
    "city": "",
    "dma": "0",
    "carrier": "",
    "platform": "macOS",
    "os_version": "10.15",
    "device_type": "PC",
    "brand": "Apple",
    "browser": "Chrome",
    "language": "en",
    "is_cookie_based": "0",
    "previous_transaction_id": "",
    "conversion_status": "approved",
    "is_event_protected": "0",
    "type": "Event",
    "event_name": "Event Example",
    "payout": ".800",
    "revenue": "1.000",
    "notes": "",
    "is_fired_pixel": "0",
    "is_scrub": "0",
    "is_view_through": "0",
    "coupon_code": "",
    "order_id": "",
    "error_code": "0",
    "error_message": "N/A",
    "sale_amount": ".000",
    "isp": "",
    "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": "",
    "network_offer_url_id": "0",
    "order_line_items": "",
    "order_number": ""
}

Conversion By ID

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

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": "02ac45e94afd438795c61c7f97be58c5", "conversion_unix_timestamp": 1605649221, "sub1": "", "sub2": "", "sub3": "", "sub4": "", "sub5": "", "source_id": "", "status": "approved", "payout_type": "cpa", "revenue_type": "rpc", "payout": 20, "revenue": 0, "session_user_ip": "127.0.0.1", "conversion_user_ip": "127.0.0.1", "country": "", "region": "", "city": "", "dma": 0, "carrier": "", "platform": "Unknown", "os_version": "", "device_type": "PC", "device_model": "", "brand": "Unknown", "browser": "", "language": "", "http_user_agent": "Apache-HttpClient/4.5.12 (Java/1.8.0_232)", "adv1": "", "adv2": "", "adv3": "", "adv4": "", "adv5": "", "is_event": false, "event": "", "notes": "", "transaction_id": "df926dccea7e4dcdb3914b5832ce2430", "click_unix_timestamp": 1605649202, "error_code": 0, "error_message": "N/A", "sale_amount": 0, "is_scrub": false, "coupon_code": "", "order_id": "", "url": "", "isp": "", "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": "CAD", "email": "", "is_view_through": false, "previous_network_offer_id": 0, "relationship": { "offer": { "network_offer_id": 23, "network_id": 1, "name": "Test Offer", "offer_status": "active" }, "advertiser": { "network_advertiser_id": 13, "network_id": 1, "name": "Van Mendoza Inc." }, "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": "Nanaho Salas Inc.", "account_status": "active" }, "affiliate_manager": { "network_employee_id": 2, "network_id": 1, "first_name": "Bob", "last_name": "Smith", "full_name": "Bob Smith", "account_status": "active" }, "query_parameters": { "nid": "1", "oid": "23", "transaction_id": "df926dccea7e4dcdb3914b5832ce2430" }, "redirect_url": "http://example.com/landing-page.php?aid=7&oid=23&tid=df926dccea7e4dcdb3914b5832ce2430", "snapshots": [ { "conversion_history_snapshot_id": 0, "network_id": 1, "conversion_id": "02ac45e94afd438795c61c7f97be58c5", "status": "approved", "error_code": 0, "payout": 20, "revenue": 0, "sale_amount": 0, "snapshot_type": "unknown", "initiator": "unknown", "network_employee": null, "unix_timestamp": 1605649221 } ], "attribution_method": "transaction_id", "click_attribution_method": "last_touch", "candidate_clicks": [ { "transaction_id": "df926dccea7e4dcdb3914b5832ce2430", "unix_timestamp": 1605649202 } ] }, "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
    }
  ]
}

Click

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).

While the clicks 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 clicks.

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.

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>'

Request

{
  "query": {
    "filters": [
      {
        "resource_type": "offer",
        "filter_id_value": "34"
      }
    ],
    "settings": {}
  },
  "from": "2020-11-13 00:00:00",
  "to": "2020-11-13 00:59:59",
  "timezone_id": 67,
  "currency_id": "USD"
}

Response

{
    "clicks": [
        {
            "transaction_id": "8ccf882ed15e4e789c7e858355c105e1",
            "is_unique": 1,
            "unix_timestamp": 1605229191,
            "tracking_url": "www.example-tracking.com",
            "source_id": "",
            "sub1": "",
            "sub2": "",
            "sub3": "",
            "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.236.221.2",
            "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": false,
            "is_pass_through": false,
            "creative_id": 0,
            "relationship": {
                "offer": {
                    "network_offer_id": 34,
                    "network_id": 1,
                    "network_advertiser_id": 9,
                    "network_offer_group_id": 0,
                    "name": "Test Offer",
                    "offer_status": "active",
                    "network_tracking_domain_id": 8,
                    "visibility": "require_approval",
                    "currency_id": "USD"
                },
                "advertiser": {
                    "network_advertiser_id": 9,
                    "network_id": 1,
                    "name": "Advertiser",
                    "account_status": "active"
                },
                "account_manager": {
                    "network_employee_id": 8,
                    "network_id": 1,
                    "first_name": "Bob",
                    "last_name": "Smith",
                    "full_name": "Bob Smith",
                    "account_status": "active"
                },
                "affiliate": {
                    "network_affiliate_id": 1,
                    "network_id": 1,
                    "name": "TestOffer",
                    "account_status": "active",
                    "network_traffic_source_id": 39
                },
                "affiliate_manager": {
                    "network_employee_id": 101,
                    "network_id": 1,
                    "first_name": "Bob",
                    "last_name": "Smith",
                    "full_name": "Bob Smith",
                    "account_status": "inactive"
                },
                "geolocation": {
                    "country_code": "US",
                    "country_name": "United States",
                    "region_code": "DC",
                    "region_name": "District of Columbia",
                    "city_name": "Washington",
                    "dma": 511,
                    "dma_name": "Washington, DC (Hagerstown, MD)",
                    "timezone": "America/New_York",
                    "carrier_name": "",
                    "carrier_code": 0,
                    "organization": "Google Cloud",
                    "isp_name": "google cloud",
                    "is_mobile": false,
                    "is_proxy": true
                },
                "device_information": {
                    "is_mobile": false,
                    "platform_name": "Unknown",
                    "os_version": "",
                    "brand": "Unknown",
                    "model": "Unknown",
                    "is_tablet": false,
                    "browser_name": "",
                    "browser_version": "Unknown",
                    "device_type": "PC",
                    "language": "",
                    "http_accept_language": "",
                    "is_robot": false,
                    "is_filter": false
                },
                "http_user_agent": "",
                "query_parameters": {},
                "redirect_url": "https://example.com/?id=8ccf882ed15e4e789c7e858355c105e1",
                "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

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": "", "sub2": "", "sub3": "", "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": "127.0.0.1", "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": "Uber Free", "offer_status": "active", "network_tracking_domain_id": 1, "visibility": "public", "currency_id": "USD" }, "advertiser": { "network_advertiser_id": 13, "network_id": 1, "name": "Van Mendoza 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": "Nanaho Salas 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": "Expedia Game", "offer_group_status": "paused", "offer_count": 0 }, "geolocation": { "country_code": "", "country_name": "", "region_code": "", "region_name": "", "city_name": "", "dma": 0, "dma_name": "", "timezone": "", "carrier_name": "", "carrier_code": 0, "organization": "", "isp_name": "", "is_mobile": false, "is_proxy": false }, "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

Path Parameters

Parameter	Description
transactionId	The Click ID (32 char)

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.

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

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.

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>'

Request

{
  "query": {
    "filters": [
      {
        "resource_type": "offer",
        "filter_id_value": "1"
      }
    ],
    "settings": {}
  },
  "from": "2020-12-10 16:00:00",
  "to": "2020-12-10 17:59:59",
  "timezone_id": 67,
  "currency_id": "USD"
}

Response

{
  "impressions": [
    {
      "transaction_id": "60e5149971d44d67af5fc63bab5c859e",
      "is_unique": 1,
      "unix_timestamp": 1607626929,
      "tracking_url": "",
      "source_id": "",
      "sub1": "",
      "sub2": "",
      "sub3": "",
      "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": "104.131.143.50",
      "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": false,
      "is_pass_through": false,
      "creative_id": 0,
      "relationship": {
        "offer": {
          "network_offer_id": 1,
          "network_id": 1,
          "network_advertiser_id": 13,
          "network_offer_group_id": 4,
          "name": "Candy Crush Uber",
          "offer_status": "active",
          "network_tracking_domain_id": 1,
          "visibility": "public",
          "currency_id": "USD"
        },
        "advertiser": {
          "network_advertiser_id": 13,
          "network_id": 1,
          "name": "Lisa Peters Inc.",
          "account_status": "active"
        },
        "account_manager": {
          "network_employee_id": 2,
          "network_id": 1,
          "first_name": "Justin",
          "last_name": "Black",
          "full_name": "Justin Black",
          "account_status": "active"
        },
        "affiliate": {
          "network_affiliate_id": 7,
          "network_id": 1,
          "name": "Bill Pace Inc.",
          "account_status": "active",
          "network_traffic_source_id": 0
        },
        "affiliate_manager": {
          "network_employee_id": 2,
          "network_id": 1,
          "first_name": "Justin",
          "last_name": "Black",
          "full_name": "Justin Black",
          "account_status": "active"
        },
        "offer_group": {
          "network_offer_group_id": 4,
          "network_id": 1,
          "network_advertiser_id": 52,
          "name": "Auto Offer",
          "offer_group_status": "active",
          "offer_count": 0
        },
        "geolocation": {
          "country_code": "US",
          "country_name": "United States",
          "region_code": "CA",
          "region_name": "California",
          "city_name": "San Francisco",
          "dma": 807,
          "dma_name": "San Francisco-Oakland-San Jose, CA",
          "timezone": "America/Los_Angeles",
          "carrier_name": "",
          "carrier_code": 0,
          "organization": "Digital Ocean Inc.",
          "isp_name": "digital ocean inc.",
          "is_mobile": false,
          "is_proxy": true
        },
        "device_information": {
          "is_mobile": false,
          "platform_name": "Windows",
          "os_version": "Vista",
          "brand": "Unknown",
          "model": "Unknown",
          "is_tablet": false,
          "browser_name": "Internet Explorer",
          "browser_version": "",
          "device_type": "PC",
          "language": "fr",
          "http_accept_language": "",
          "is_robot": false,
          "is_filter": false
        },
        "http_accept_language": "fr",
        "query_parameters": {},
        "forensiq_score": "0"
      },
      "coupon_code": "",
      "redirect_method": "",
      "is_sdk_click": false
    }
  ]
}

Dashboard Summary

This endpoint list comparative data for standard metrics. For every metrics, values for current month vs total of last month and today vs total of yesterday are listed. Performance value is 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": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "payout": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "profit": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "margin": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "click": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "conversion": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "event": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "cvr": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "evr": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "cpc": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "epc": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "rpc": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 }, "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": 0, "yesterday": 0, "current_month": 0, "last_month": 0, "trending_percentage": 0 }, "gross_click": { "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 }, "ctr": { "today": 0, "yesterday": 0, "current_month": 0, "last_month": 0 } }

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.

Request Example

cURL

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

Request

 {
  "from": "",
  "to": "",
  "timezone_id": 0,
  "currency_id": "",
  "query": {
    "filters": [],
    "search_terms": []
  },
  "columns": [
    {
      "column": "offer"
    }
  ]
}

Variance

POST v1/networks/reporting/variance

This endpoint allows you to compare different metrics between two periods of time on a selected value.

Filters

This endpoint supports basic filtering. Refer to API filters page for usage.

Request Example

cURL

curl --request POST 'https://api.eflow.team/v1/networks/reporting/variance' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'

Request

{
    "previous_from": "",
    "previous_to": "",
    "current_from": "",
    "current_to": "",
    "timezone_id": 0,
    "currency_id": "",
    "query": {
        "filters": [
            {
                "resource_type": "offer",
                "filter_id_value": "12"
            }
        ],
        "settings": {
            "campaign_data_only": true,
            "ignore_fail_traffic": true,
            "only_include_fail_traffic": true
        },
        "metric_filters": [
            {
                "metric_type": "impression",
                "operator": "less_than",
                "metric_value": 200
            }
        ]
    },
    "columns": [
        {
            "column": "unix_timestamp"
        }
    ]
}