Postbacks

Operations for postbacks

Find All

GET /v1/affiliates/pixels

Filters

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

Value Description
network_offer_id Filter based on the offer id
network_affiliate_id Filter based on the affiliate id
network_offer_payout_revenue_id Filter based on the offer payout & revenue id
pixel_status Filter based on the pixel status
pixel_type Filter based on the pixel type
delivery_method Filter based on the delivery method
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET 'https://api.eflow.team/v1/affiliates/pixels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
    "pixels": [
        {
            "network_pixel_id": 1,
            "network_id": 1,
            "network_affiliate_id": 7,
            "network_offer_id": 1,
            "network_offer_payout_revenue_id": 0,
            "delivery_method": "postback",
            "pixel_level": "specific",
            "pixel_status": "active",
            "pixel_type": "conversion",
            "postback_url": "https://testpostback.com",
            "html_code": "",
            "time_created": 1603373152,
            "time_saved": 1603373687,
            "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
                },
                "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
        }
    ]
}

Find By ID

GET /v1/affiliates/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/affiliates/pixels/<INSERT PIXEL ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
    "network_pixel_id": 1,
    "network_id": 1,
    "network_affiliate_id": 7,
    "network_offer_id": 1,
    "network_offer_payout_revenue_id": 0,
    "delivery_method": "postback",
    "pixel_level": "specific",
    "pixel_status": "active",
    "pixel_type": "conversion",
    "postback_url": "https://testpostback.com",
    "html_code": "",
    "time_created": 1603373152,
    "time_saved": 1603373687,
    "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
        },
        "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
}

Find (Advanced)

POST /v1/affiliates/pixelstable

Paging

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

This endpoint supports query filters.

search_terms object array
search_type string

The name of the field used for search.

value string

The value to search.

filters object
description string

Optional description.

html_code string

HTML code of the postback.

network_affiliate_id int

ID of the affiliate related to the postback.

network_offer_id int

ID of the offer related to the postback.

postback_url string

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

network_pixel_id int

ID of the postback.

cURL
curl --request POST 'https://api.eflow.team/v1/affiliates/pixelstable' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'Content-Type: application/json' \
--data '<INSERT PAYLOAD>'
Response
{
    "pixels": [
        {
            "network_pixel_id": 1,
            "network_id": 1,
            "network_offer_payout_revenue_id": 0,
            "delivery_method": "postback",
            "pixel_level": "specific",
            "pixel_status": "active",
            "pixel_type": "conversion",
            "postback_url": "https://testpostback.com",
            "html_code": "",
            "network_affiliate_id": 7,
            "network_affiliate_name": "Affiliate Example",
            "network_offer_id": 1,
            "network_offer_name": "Offer Example",
            "time_created": 1603373152,
            "time_saved": 1603373687,
            "relationship": {}
        },
        {
            "network_pixel_id": 2,
            "network_id": 1,
            "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": "",
            "network_affiliate_id": 7,
            "network_affiliate_name": "Affiliate Example",
            "network_offer_id": 0,
            "network_offer_name": "Offer Example",
            "time_created": 1603382705,
            "time_saved": 1603382909,
            "relationship": {}
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 2
    }
}

Create

POST /v1/affiliates/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.

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.

To create a global postback (that will affect all offers) for conversions, the following payload would work :

{
    "pixel_type": "conversion",
    "pixel_status": "active",
    "pixel_level": "global",
    "delivery_method": "postback",
    "html_code": "",
    "postback_url": "http://postback-url.com?s2={sub2}&s1={sub1}",
    "description": "Your description"
}

For a specific event postback, specifying the offer id and the event id is necessary. Here is an example payload :

{
    "network_offer_id": 21,
    "network_offer_payout_revenue_id": 152,
    "delivery_method": "postback",
    "pixel_type": "post_conversion",
    "pixel_status": "active",
    "pixel_level": "specific",
    "html_code": "",
    "postback_url": "http://postback-url.com?s2={sub2}&s1={sub1}",
    "description": "Your description"
}

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": "",
    "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/affiliates/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.

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": "post_conversion",
    "postback_url": "http://test3.com{sub2}{sub1}",
    "html_code": "",
    "description": "Your postback",
    "facebook_pixel": null
}

cURL
curl --request POST 'https://api.eflow.team/v1/affiliates/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": "",
    "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
}