Reporting

Operations for reporting

Entity

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

POST /v1/affiliates/reporting/entity

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

Request

{
  "from": "2020-10-01",
  "to": "2020-10-02",
  "timezone_id": 67,
  "currency_id": "USD",
  "query": {
    "filters": [
      {
        "resource_type": "offer",
        "filter_id_value": "1"
      }
    ],
    "exclusions": [
      {
        "resource_type": "offer",
        "filter_id_value": "3"
      }
    ]
  },
  "columns": [
    {
      "column": "offer"
    }
  ]
}

Conversions

POST /v1/affiliates/reporting/conversions

cURL
curl --request POST 'https://api.eflow.team/v1/affiliates/reporting/conversions' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'
Request
{
  "show_conversions": true,
  "show_events": true,
  "show_only_vt": true,
  "show_only_ct": true,
  "from": "",
  "to": "",
  "timezone_id": 0,
  "currency_id": "",
  "query": {
    "filters": [
      {
        "resource_type": "offer",
        "filter_id_value": ""
      }
    ],
    "search_terms": [
      {
        "search_type": "transaction_id",
        "value": ""
      }
    ]
  }
}

Response

{
  "data": [
    {
      "adv1": "",
      "adv2": "",
      "adv3": "",
      "adv4": "",
      "adv5": "",
      "android_id": "",
      "android_id_md5": "",
      "android_id_sha1": "",
      "app_id": "",
      "brand": "Apple",
      "browser": "Safari",
      "carrier": "",
      "city": "Wolfville",
      "click_unix_timestamp": 1603469414,
      "conversion_id": "",
      "conversion_unix_timestamp": 1603469424,
      "conversion_user_ip": "",
      "country": "Canada",
      "currency_id": "USD",
      "device_type": "Mobile",
      "dma": 0,
      "event": "Base",
      "google_ad_id": "",
      "google_ad_id_md5": "",
      "google_ad_id_sha1": "",
      "http_user_agent": "",
      "idfa": "",
      "idfa_md5": "",
      "idfa_sha1": "",
      "is_event": false,
      "is_view_through": false,
      "isp": "acadia university",
      "language": "en",
      "order_id": "",
      "os_version": "9.2",
      "platform": "iOS",
      "referer": "",
      "region": "Nova Scotia",
      "relationship": {
        "events_count": 0,
        "offer": {
          "name": "Offer Example",
          "network_id": 5,
          "network_offer_id": 883,
          "network_tracking_domain_id": 8,
          "offer_status": "active"
        }
      },
      "revenue": 3.5,
      "revenue_type": "CPA",
      "session_user_ip": "",
      "source_id": "1000",
      "sub1": "mobileweb",
      "sub2": "19",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "transaction_id": ""
    },
    {
      "adv1": "",
      "adv2": "",
      "adv3": "",
      "adv4": "",
      "adv5": "",
      "android_id": "",
      "android_id_md5": "",
      "android_id_sha1": "",
      "app_id": "",
      "brand": "Samsung",
      "browser": "Chrome",
      "carrier": "",
      "city": "Sao Jose Dos Campos",
      "click_unix_timestamp": 1603469101,
      "conversion_id": "",
      "conversion_unix_timestamp": 1603469120,
      "conversion_user_ip": "",
      "country": "Brazil",
      "currency_id": "USD",
      "device_type": "Mobile",
      "dma": 0,
      "event": "Sliders Pyramid",
      "google_ad_id": "",
      "google_ad_id_md5": "",
      "google_ad_id_sha1": "",
      "http_user_agent": "",
      "idfa": "",
      "idfa_md5": "",
      "idfa_sha1": "",
      "is_event": false,
      "is_view_through": false,
      "isp": "claro brazil",
      "language": "en",
      "order_id": "",
      "os_version": "6.0",
      "platform": "Android",
      "referer": "",
      "region": "Sao Paulo",
      "relationship": {
        "events_count": 0,
        "offer": {
          "name": "Offer Example",
          "network_id": 5,
          "network_offer_id": 882,
          "network_tracking_domain_id": 8,
          "offer_status": "active"
        }
      },
      "revenue": 0.8,
      "revenue_type": "CPA",
      "session_user_ip": "",
      "source_id": "1000",
      "sub1": "rtb",
      "sub2": "79",
      "sub3": "",
      "sub4": "",
      "sub5": "",
      "transaction_id": ""
    }
  ],
  "recordsFiltered": 93,
  "recordsTotal": 93
}


Conversion By ID

GET /v1/affiliates/reporting/conversions/:conversionId

Path Parameters

Parameter Description
conversionId The ID of the conversion

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/reporting/conversions/<INSERT CONVERSION ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "conversion_id": "",
  "conversion_unix_timestamp": 1603468520,
  "sub1": "internal",
  "sub2": "70",
  "sub3": "",
  "sub4": "",
  "sub5": "",
  "source_id": "1000",
  "revenue_type": "CPA",
  "revenue": 0.8,
  "session_user_ip": "",
  "conversion_user_ip": "",
  "country": "United States",
  "region": "New Jersey",
  "city": "Middletown",
  "dma": 501,
  "carrier": "AT&T Wireless USA",
  "platform": "iOS",
  "os_version": "10.2",
  "device_type": "Mobile",
  "brand": "Apple",
  "browser": "Safari",
  "language": "en",
  "http_user_agent": "",
  "is_event": false,
  "event": "",
  "transaction_id": "",
  "click_unix_timestamp": 1603468510,
  "isp": "att global network services llc",
  "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": 882,
      "network_id": 5,
      "name": "Offer Example",
      "offer_status": "active",
      "network_tracking_domain_id": 8
    },
    "events_count": 0
  }
}

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

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/dashboard/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "click": {
    "current_month": 226476,
    "last_month": 738534,
    "today": 4738,
    "trending_percentage": -4.4,
    "yesterday": 9223
  },
  "conversion": {
    "current_month": 3960,
    "last_month": 7029,
    "today": 88,
    "trending_percentage": 2.3,
    "yesterday": 179
  },
  "cvr": {
    "current_month": 1.749,
    "last_month": 0.952,
    "today": 1.857,
    "yesterday": 1.941
  },
  "events": {
    "current_month": 351,
    "last_month": 4243,
    "today": 5,
    "trending_percentage": 66.7,
    "yesterday": 7
  },
  "evr": {
    "current_month": 8,
    "last_month": 60,
    "today": 5,
    "yesterday": 3
  },
  "impression": {
    "current_month": 0,
    "last_month": 0,
    "today": 0,
    "trending_percentage": 0,
    "yesterday": 0
  },
  "redirect_revenue": {
    "current_month": 0,
    "last_month": 0,
    "today": 0,
    "trending_percentage": 0,
    "yesterday": 0
  },
  "revenue": {
    "current_month": 5231,
    "last_month": 26730,
    "today": 107,
    "trending_percentage": 4.3,
    "yesterday": 198.9
  }
}