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

POST /advertisers/reporting/entity

cURL
curl --request POST 'https://api.eflow.team/v1/advertisers/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"
      }
    ],
    "metric_filters": [
      {
        "metric_type": "impression",
        "operator": "less_than",
        "metric_value": 0
      }
    ],
    "exclusions": [
      {
        "resource_type": "offer",
        "filter_id_value": "3"
      }
    ]
  },
  "columns": [
    {
      "column": "offer"
    }
  ]
}

Conversion

POST /v1/advertisers/reporting/conversions

cURL
curl --request POST 'https://api.eflow.team/v1/advertisers/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": "",
      "brand": "Apple",
      "browser": "Safari",
      "carrier": "",
      "city": "",
      "click_unix_timestamp": 1603467315,
      "conversion_id": "",
      "conversion_unix_timestamp": 1603467321,
      "conversion_user_ip": "",
      "cost": 10,
      "cost_type": "RPA",
      "country": "",
      "currency_id": "USD",
      "device_type": "Mobile",
      "dma": 0,
      "event": "Base",
      "http_user_agent": "",
      "is_event": false,
      "isp": "",
      "language": "en",
      "os_version": "10.3",
      "platform": "iOS",
      "region": "",
      "relationship": {
        "affiliate": {
          "account_status": "inactive",
          "name": "N/A",
          "network_affiliate_id": 0,
          "network_id": 5
        },
        "affiliate_id": 0,
        "events_count": 0,
        "offer": {
          "name": "Crush Candy Crush Saga",
          "network_id": 5,
          "network_offer_id": 880,
          "offer_status": "active"
        },
        "source_id": "",
        "sub1": "",
        "sub2": "",
        "sub3": "",
        "sub4": "",
        "sub5": ""
      },
      "session_user_ip": "",
      "transaction_id": ""
    }
  ],
  "recordsFiltered": 1,
  "recordsTotal": 1
}


Conversion By ID

GET /v1/advertisers/reporting/conversions/:conversionId

Path Parameters

Parameter Description
conversionId The ID of the conversion

cURL
curl --request GET 'https://api.eflow.team/v1/advertisers/reporting/conversions/<INSERT CONVERSION ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "adv1": "",
  "adv2": "",
  "adv3": "",
  "adv4": "",
  "adv5": "",
  "brand": "Apple",
  "browser": "Safari",
  "carrier": "",
  "city": "",
  "click_unix_timestamp": 1603467315,
  "conversion_id": "",
  "conversion_unix_timestamp": 1603467321,
  "conversion_user_ip": "",
  "cost": 10,
  "cost_type": "RPA",
  "country": "",
  "currency_id": "USD",
  "device_type": "Mobile",
  "dma": 0,
  "event": "",
  "http_user_agent": "",
  "is_event": false,
  "isp": "",
  "language": "en",
  "os_version": "10.3",
  "platform": "iOS",
  "region": "",
  "relationship": {
    "affiliate": null,
    "affiliate_id": 0,
    "events_count": 0,
    "offer": {
      "name": "Crush Candy",
      "network_id": 5,
      "network_offer_id": 880,
      "offer_status": "active"
    },
    "source_id": "",
    "sub1": "",
    "sub2": "",
    "sub3": "",
    "sub4": "",
    "sub5": ""
  },
  "session_user_ip": "",
  "transaction_id": ""
}

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

cURL
curl --request GET 'https://api.eflow.team/v1/advertisers/dashboard/summary' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "click": {
    "current_month": 1094345,
    "last_month": 2330179,
    "today": 34245,
    "trending_percentage": -1.6,
    "yesterday": 46221
  },
  "conversion": {
    "current_month": 20945,
    "last_month": 31160,
    "today": 676,
    "trending_percentage": 2.1,
    "yesterday": 878
  },
  "cost": {
    "current_month": 297842,
    "last_month": 980543,
    "today": 8700.5,
    "trending_percentage": -12.6,
    "yesterday": 12118
  },
  "cvr": {
    "current_month": 1.914,
    "last_month": 1.337,
    "today": 1.974,
    "yesterday": 1.9
  },
  "events": {
    "current_month": 4667,
    "last_month": 13918,
    "today": 142,
    "trending_percentage": 0,
    "yesterday": 194
  },
  "evr": {
    "current_month": 22,
    "last_month": 44,
    "today": 21,
    "trending_percentage": 0,
    "yesterday": 22
  },
  "imp": {
    "current_month": 1,
    "last_month": 0,
    "today": 0,
    "trending_percentage": 0,
    "yesterday": 0
  }
}