Partner Postbacks

Operations for partner postbacks

Fetch Postbacks

POST /v1/networks/pixelstable

This is the main endpoint to extract a list of partner postbacks from the API. It’s possible to filter the postbacks returned by this endpoint using 2 different methods (which can be combined) :

  • Search Terms : equivalent to a text search (e.g. find postbacks with a description that contains the word “media buyer”)
  • Query Filters : structured filters on predefined fields (e.g. find partner postbacks for partner ID 10)

Paging

This endpoint supports paging. Refer to our User Guide for usage.

search_terms object array

This is a text search on the name or advertiser of the offer

search_type string

The name of the field used for search. Can be one of the following values: pixel_id, description or payload. The payload option will search in the HTML code or the postback URL, depending on the nature of the partner postback

value string

The value to search.

filters object

Structured filters

offer_status string

Status of the partner postback. Can be one of the following values: active, inactive.

pixel_type string

Type / target of the partner postback. Can be one of the following values: conversion, post_conversion or cpc.

network_offer_ids int array

Only include postbacks that target the offers specified in the list. Note that global postbacks (that target all offers) will be returned when this filter is used.

network_affiliate_ids int array

Only include postbacks that belong to the partners specified in the list. Note that global offer postbacks (that fire regardless of the partner) will be returned when this filter is used.

delivery_methods string array

Only include partner postbacks that use one of the delivery methods specified. The array can contain multiple delivery methods, but the possibilities are : facebook, tiktok, postback, html

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

Example 1 : Fetch all active conversion postbacks

{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "conversion",
    }
  }
}

To fetch, for example, the second page of 50 active conversion postbacks you would run the following call :

curl --request POST 'https://api.eflow.team/v1/networks/pixelstable?page=2&page_size=50' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "conversion",
    }
  }
}'

Example 2 : Fetch all event postbacks with delivery method postback that contain the work some-site in the URL

{
  "query": {
    "filters": {
      "status": "active",
      "pixel_type": "post_conversion",
      "delivery_methods": [ "postback" ],
    },
    "search_terms": [
      {
        "search_type": "payload",
        "value": "some-site"
      }
    ]
  }
}
Response
{
  "pixels": [
    {
      "network_pixel_id": 20,
      "network_id": 1,
      "network_offer_payout_revenue_id": 0,
      "delivery_method": "html",
      "pixel_level": "specific",
      "pixel_status": "active",
      "pixel_type": "post_conversion",
      "postback_url": "",
      "html_code": "<div>pixel content</div>",
      "delay_ms": 0,
      "network_affiliate_id": 22,
      "network_affiliate_name": "Affiliate Name",
      "network_offer_id": 40,
      "network_offer_name": "Offer Name",
      "description": "",
      "time_created": 1496184631,
      "time_saved": 1498173406,
      "relationship": {}
    },
    {
      "network_pixel_id": 112,
      "network_id": 1,
      "network_offer_payout_revenue_id": 0,
      "delivery_method": "postback",
      "pixel_level": "global_offer",
      "pixel_status": "active",
      "pixel_type": "conversion",
      "postback_url": "https://postbackdomain.com/?offer_id={offer_id}&transaction_id={transaction_id}&google_aid={google_aid}&idfa={idfa}",
      "html_code": "",
      "delay_ms": 0,
      "network_affiliate_id": 0,
      "network_affiliate_name": "",
      "network_offer_id": 81,
      "network_offer_name": "Other Offer Name",
      "description": "",
      "time_created": 1506462264,
      "time_saved": 1506462264,
      "relationship": {}
    }
  ],
  "paging": {
    "page": 1,
    "page_size": 50,
    "total_count": 2
  }
}

Find By ID

GET /v1/networks/pixels/:pixelId

Path Parameters

Parameter Description
pixelId The ID of the postback you want to fetch

cURL
curl --request GET 'https://api.eflow.team/v1/networks/pixels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "network_pixel_id": 1,
  "network_id": 1,
  "network_affiliate_id": 14,
  "network_offer_id": 0,
  "network_offer_payout_revenue_id": 0,
  "delivery_method": "postback",
  "pixel_level": "global",
  "pixel_status": "active",
  "pixel_type": "conversion",
  "postback_url": "https://postbacktest.com",
  "html_code": "",
  "delay_ms": 0,
  "description": "your postback",
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 14,
      "network_id": 1,
      "name": "Affiliate Example",
      "account_status": "active",
      "network_employee_id": 2,
      "internal_notes": "",
      "has_notifications": false,
      "network_traffic_source_id": 0,
      "account_executive_id": 0,
      "adress_id": 0,
      "default_currency_id": "USD",
      "is_contact_address_enabled": false,
      "enable_media_cost_tracking_links": true,
      "time_created": 1594391076,
      "time_saved": 1594391076,
      "referrer_id": 0
    }
  },
  "facebook_pixel": null
}

Create

POST /v1/networks/pixels

network_affiliate_id int

ID of the affiliate related to the postback.

network_offer_id int

ID of the offer related to the postback.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global, specific or global_offer.

pixel_status string

Status of the postback. Can either be active or inactive.

pixel_type string

Determines type of postback. Conversion is fired for the based CV action and Event is for any post-conversion events. CPC is used specifically for individual offers that have CPC payouts, and fires on every unique payable click action. It can be a conversion, post_conversion or cpc.

postback_url string

Url of the postback. Note that the URL requires http(s)://

html_code string

HTML code of the postback.

delay_ms int

An optional delay (expressed in milliseconds) that the system will wait before firing the postback. Only relevant when postback delivery method is used. The maximum delay allowd is 5 minutes, or 300000 milliseconds.

description string

Optional description.

facebook_pixel object
network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

pixel_id string

ID of the postback

event_name string

Name of the event.

user_data object array
field string

Date type of the facebook user. Can be email, phone, gender, date_of_birth, last_name, first_name, city, state, zipcode, country_code, external_id, fbc, fbp, subscription_id, or fb_login_id.

value string

Value associated with a type of data.

custom_data object array
field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

{
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global_offer",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "http://test2.com?s2={sub2}&s1={sub1}",
    "html_code": "",
    "description": "Your postback"
}

cURL
curl --request POST 'https://api.eflow.team/v1/affiliates/pixels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'
Response
{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 0,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global_offer",
    "pixel_status": "inactive",
    "pixel_type": "post_conversion",
    "postback_url": "http://test2.com{sub2}{sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603484530,
    "relationship": {
        "offer": {
            "network_offer_id": 1,
            "network_id": 1,
            "network_advertiser_id": 13,
            "network_offer_group_id": 0,
            "name": "Offer Example",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        }
    },
    "facebook_pixel": null
}

Update

PUT /v1/networks/pixels/:pixelId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter Description
pixelId The ID of the postback you want to update

network_affiliate_id int

ID of the affiliate related to the postback.

network_offer_id int

ID of the offer related to the postback.

network_offer_payout_revenue_id int

ID of the offer payout and revenue related to the postback.

delivery_method string

Select whether the postback will be fired from an HTML tag/pixel, or via an S2S (Server to Server) Postback. Can be html, postback or facebook.

pixel_level string

Determines if the postback should be used for all offers, or only one selected offer. Can either be global, specific or global_offer.

pixel_status string

Status of the postback. Can either be active or inactive.

pixel_type string

Determines type of postback. Conversion is fired for the based CV action and Event is for any post-conversion events. CPC is used specifically for individual offers that have CPC payouts, and fires on every unique payable click action. It can be a conversion, post_conversion or cpc.

postback_url string

Url of the postback. Note that the URL requires http(s)://

html_code string

HTML code of the postback.

delay_ms int

An optional delay (expressed in milliseconds) that the system will wait before firing the postback. Only relevant when postback delivery method is used. The maximum delay allowd is 5 minutes, or 300000 milliseconds.

description string

Optional description.

facebook_pixel object
network_affiliate_integration_facebook_business_id int

ID of the affiliate integration facebook business.

pixel_id string

ID of the postback

event_name string

Name of the event.

user_data object array
field string

Date type of the facebook user. Can be email, phone, gender, date_of_birth, last_name, first_name, city, state, zipcode, country_code, external_id, fbc, fbp, subscription_id, or fb_login_id.

value string

Value associated with a type of data.

custom_data object array
field string

Custom date by facebook. Can be value, currency, order_id, predicted_ltv, num_items, status, or search_string.

value string

Value associated with a type of data.

{
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "http://test3.com?s2={sub2}&s1={sub1}",
    "html_code": "",
    "description": "Your postback"
}

cURL
curl --request POST 'https://api.eflow.team/v1/networks/pixels/<INSERT PIXEL ID' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'
Response
{
    "network_pixel_id": 3,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 0,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "global",
    "pixel_status": "active",
    "pixel_type": "post_conversion",
    "postback_url": "http://test3.com{sub2}{sub1}",
    "html_code": "",
    "delay_ms": 0,
    "time_created": 1603484530,
    "time_saved": 1603485164,
    "relationship": {
        "affiliate": {
            "network_affiliate_id": 7,
            "network_id": 1,
            "name": "Affiliate Example",
            "account_status": "active",
            "network_employee_id": 2,
            "internal_notes": "",
            "has_notifications": false,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "USD",
            "is_contact_address_enabled": false,
            "enable_media_cost_tracking_links": true,
            "time_created": 1602783082,
            "time_saved": 1602783082,
            "referrer_id": 0
        }
    },
    "facebook_pixel": null
}