Event Report

Operations to fetch the Event Report

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.

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 pivot column that will either be event_name or advertiser_event_name depending on the events you are interested in
  • One or two columns to break down the data

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.

Optional query filters can be added to the call.

The columns you request to break down the data will be one or two of the following :

offer, offer_id, offer_group, offer_group_id, creative, creative_id, category, campaign, campaign_id, offer_url, project_id, affiliate, affiliate_id, affiliate_manager, advertiser, advertiser_id, account_manager, sales_manager, account_executive, country, region, city, dma, isp, carrier, connection_type, platform, os_version, device_type, browser, device_make, language, device_model, source_id, referer, sub1, sub2, sub3, sub4, sub5

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 events for US traffic on offer 883 OR offer 518”.

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

offer, offer_group, affiliate, advertiser, offer_creative, affiliate_tier, campaign, billing_frequency, business_unit, tracking_domain

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

Request

{
  "from": "2022-02-10",
  "to": "2022-02-10",
  "timezone_id": 67,
  "columns": [
    {
      "column": "offer"
    },
    {
      "column": "affiliate"
    },
    {
      "column": "event_name"
    }
  ],
  "query": {
    "filters": [
      {
          "filter_id_value": "883",
          "resource_type": "offer"
      }
    ]
  }
}