Smart Links

Operations for smart links

Find All

GET /v1/networks/campaigns

Filters

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

Relationships

This endpoint supports the following additional relationships. Refer to our User Guide for usage.

You can ask for them using the relationship query parameter. Multiple relationships can be supplied repeating the relationship query parameter.

Value Description
reporting Includes the campaign’s reporting for today
redirects Includes the campaign’s redirects
offers Includes the campaign’s list of offers used in the redirects
catch_all_offer_basic Includes the campaign’s catch-all offer

cURL
curl --request GET 'https://api.eflow.team/v1/networks/campaigns?relationship=redirects' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
    "campaigns":
    [
        {
            "network_campaign_id": 1,
            "network_id": 1,
            "campaign_name": "Example SmartLink",
            "campaign_status": "active",
            "network_tracking_domain_id": 1,
            "is_use_secure_link": true,
            "redirect_routing_type": "priority",
            "catch_all_network_offer_id": 775,
            "is_open_to_affiliates": true,
            "run_frequency": "unknown",
            "metric": "unknown",
            "optimization_goal": 0,
            "data_lookback_window": "unknown",
            "data_collection_threshold": 0,
            "time_created": 1633017537,
            "time_saved": 1633017604,
            "relationship":
            {
                "redirects":
                {
                    "total": 2,
                    "entries":
                    [
                        {
                            "network_campaign_redirect_id": 1,
                            "network_campaign_id": 1,
                            "redirect_network_offer_id": 10,
                            "redirect_network_offer_url_id": 0,
                            "routing_value": 1
                        },
                        {
                            "network_campaign_redirect_id": 2,
                            "network_campaign_id": 1,
                            "redirect_network_offer_id": 3,
                            "redirect_network_offer_url_id": 0,
                            "ruleset":
                            {
                                "network_id": 1,
                                "network_ruleset_id": 774,
                                "time_created": 1633017537,
                                "time_saved": 1633017537,
                                "countries":
                                [
                                    {
                                        "network_id": 1,
                                        "network_targeting_country_id": 156,
                                        "country_id": 36,
                                        "label": "Canada",
                                        "country_code": "CA",
                                        "targeting_type": "include",
                                        "match_type": "exact"
                                    }
                                ]
                            },
                            "routing_value": 2,
                        }
                    ]
                },
                "labels":
                {
                    "total": 2,
                    "entries":
                    [
                        "label1",
                        "label2"
                    ]
                },
                "encoded_value": "27W1G"
            }
        }
    ]
}

Find By ID

GET /v1/networks/campaigns/:campaignId

Path Parameters

Parameter Description
campaignId The ID of the campaign you want to fetch

Relationships

This endpoint supports the following additional relationships. Refer to our User Guide for usage.

You can ask for them using the relationship query parameter. Multiple relationships can be supplied repeating the relationship query parameter.

Value Description
reporting Includes the campaign’s reporting for today
redirects Includes the campaign’s redirects
offers Includes the campaign’s list of offers used in the redirects
catch_all_offer_basic Includes the campaign’s catch-all offer

cURL
curl --request GET 'https://api.eflow.team/v1/networks/campaigns/1?relationship=redirects' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
 {
  "network_campaign_id": 1,
  "network_id": 1,
  "campaign_name": "Example SmartLink",
  "campaign_status": "active",
  "network_tracking_domain_id": 1,
  "is_use_secure_link": true,
  "redirect_routing_type": "priority",
  "catch_all_network_offer_id": 775,
  "is_open_to_affiliates": true,
  "run_frequency": "unknown",
  "metric": "unknown",
  "optimization_goal": 0,
  "data_lookback_window": "unknown",
  "data_collection_threshold": 0,
  "time_created": 1633017537,
  "time_saved": 1633017604,
  "relationship": {
    "redirects": {
      "total": 2,
      "entries": [
        {
          "network_campaign_redirect_id": 1,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 2601,
          "redirect_network_offer_url_id": 0,
          "routing_value": 1
        },
        {
          "network_campaign_redirect_id": 2,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 3,
          "redirect_network_offer_url_id": 0,
          "ruleset": {
            "network_id": 1,
            "network_ruleset_id": 774,
            "time_created": 1633017537,
            "time_saved": 1633017537,
            "countries": [
              {
                "network_id": 1,
                "network_targeting_country_id": 156,
                "country_id": 36,
                "label": "Canada",
                "country_code": "CA",
                "targeting_type": "include",
                "match_type": "exact"
              }
            ]
          },
          "routing_value": 2,
        }
      ]
    },
    "labels": {
      "total": 2,
      "entries": [
        "label1",
        "label2"
      ]
    },
    "encoded_value": "27W1G"
  }
}

Create

POST /v1/networks/campaigns

campaign_name string

The displayed name of the smart link.

campaign_status string

Status of the smart link. Can be one of the following values: active , paused , deleted

network_tracking_domain_id int

The ID of the domain to be used in the affiliate tracking link.

is_use_secure_link boolean

Whether or not you want to force SSL. Improves tracking and security by setting tracking links to always use the more secure https:// instead of http:// .

redirect_routing_type string

The redirect mechanism of the campaign. Determines how the Smart Link traffic is distributed between the listed offers. KPI allows you to automatically deliver traffic ranked in order of the best performing offers for your set KPI. Priority means the first position will be checked, and if the user doesn’t match the offer’s targeting/cap, then it will continue downwards towards the next eligible offer. Choosing Weight will deliver traffic with a percentage split between eligible offers. Can be one of the following values: priority , weight , kpi .

catch_all_network_offer_id int

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if partner has access to the offer and the click can’t be matched with any of the offers in the redirect tree.

is_open_to_affiliates boolean

Whether or not you want to make the campaign visible to affiliates. If this option is enabled, the Smart Link will be visible to the partner only if all the offers are runnable by the partner.

run_frequency string

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Can be one of the following values: 12_hours , 24_hours . Required if redirect_routing_type is set to kpi .

metric string

The metric to use with the KPI campaign. The highest performing offers for your selected metric will be re-ranked towards receiving the majority of the Smart Link traffic. Can be one of the following values: profit , cvr , evr , conversions , payout , revenue . Required if redirect_routing_type is set to kpi .

optimization_goal int

This optimizes ranking towards the offers that are closest towards your set Specific Goal. Required if redirect_routing_type is set to kpi .

data_lookback_window string

Determines the period of data being used for determining how offers are performing at your set Metric. Can be one of the following values: 12_hours , 24_hours , 48_hours . Required if redirect_routing_type is set to kpi .

data_collection_threshold int

The amount of data required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi .

redirects object array

The list of offers that are part of the campaign.

redirect_network_offer_id int

The ID of the offer.

redirect_network_offer_url_id int

The ID of an offer URL. Defaults to the Base Destination URL.

ruleset object

List of rules for which the redirect applies. See the ruleset object.

routing_value int

The value used to determine the priority or the weight of the offer in the list. Required if redirect_routing_type is set to priority or weight .

labels string array

The list of labels associated with the campaign.

{
    "network_tracking_domain_id": 1,
    "campaign_status": "active",
    "catch_all_network_offer_id": 1,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "is_use_secure_link": true,
    "is_open_to_affiliates": false,
    "campaign_name": "test",
    "redirects":
    [
        {
            "redirect_network_offer_id": 3,
            "routing_value": 1,
                    "redirect_network_offer_url_id": 0,
            "ruleset":
            {
                "countries":
                [
                    {
                        "targeting_type": "include",
                        "match_type": "exact",
                        "country_id": 227
                    }
                ]
            }
        },
        {
            "redirect_network_offer_id": 775,
            "routing_value": 2,
            "redirect_network_offer_url_id": 0
        }
    ],
    "redirect_routing_type": "priority"
}

Update

PUT /v1/networks/campaigns/:campaignId

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
campaignId The ID of the smart link you want to update

campaign_name string

The displayed name of the smart link.

campaign_status string

Status of the smart link. Can be one of the following values: active , paused , deleted

network_tracking_domain_id int

The ID of the domain to be used in the affiliate tracking link.

is_use_secure_link boolean

Whether or not you want to force SSL. Improves tracking and security by setting tracking links to always use the more secure https:// instead of http:// .

redirect_routing_type string

The redirect mechanism of the campaign. Determines how the Smart Link traffic is distributed between the listed offers. KPI allows you to automatically deliver traffic ranked in order of the best performing offers for your set KPI. Priority means the first position will be checked, and if the user doesn’t match the offer’s targeting/cap, then it will continue downwards towards the next eligible offer. Choosing Weight will deliver traffic with a percentage split between eligible offers. Can be one of the following values: priority , weight , kpi .

catch_all_network_offer_id int

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if partner has access to the offer and the click can’t be matched with any of the offers in the redirect tree.

is_open_to_affiliates boolean

Whether or not you want to make the campaign visible to affiliates. If this option is enabled, the Smart Link will be visible to the partner only if all the offers are runnable by the partner.

run_frequency string

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Can be one of the following values: 12_hours , 24_hours . Required if redirect_routing_type is set to kpi .

metric string

The metric to use with the KPI campaign. The highest performing offers for your selected metric will be re-ranked towards receiving the majority of the Smart Link traffic. Can be one of the following values: profit , cvr , evr , conversions , payout , revenue . Required if redirect_routing_type is set to kpi .

optimization_goal int

This optimizes ranking towards the offers that are closest towards your set Specific Goal. Required if redirect_routing_type is set to kpi .

data_lookback_window string

Determines the period of data being used for determining how offers are performing at your set Metric. Can be one of the following values: 12_hours , 24_hours , 48_hours . Required if redirect_routing_type is set to kpi .

data_collection_threshold int

The amount of data required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi .

redirects object array

The list of offers that are part of the campaign.

redirect_network_offer_id int

The ID of the offer.

redirect_network_offer_url_id int

The ID of an offer URL. Defaults to the Base Destination URL.

ruleset object

List of rules that apply to the redirect. See the ruleset object.

routing_value int

The value used to determine the priority or the weight of the offer in the list. Required if redirect_routing_type is set to priority or weight .

labels string array

The list of labels associated with the campaign.

{
    "network_campaign_id": 1,
    "network_id": 1,
    "campaign_name": "Updated Smartlink",
    "campaign_status": "active",
    "network_tracking_domain_id": 1,
    "is_use_secure_link": true,
    "redirect_routing_type": "priority",
    "catch_all_network_offer_id": 10,
    "is_open_to_affiliates": true,
    "conversion_method": "server_postback",
    "is_whitelist_check_enabled": false,
    "labels":
    [
        "label1",
        "label2"
    ],
    "redirects":
    [
        {
            "redirect_network_offer_id": 3,
            "routing_value": 1,
            "ruleset":
            {
                "countries":
                [
                    {
                        "targeting_type": "include",
                        "match_type": "exact",
                        "country_id": 227
                    }
                ]
            }
        },
        {
            "redirect_network_offer_id": 775,
            "routing_value": 2,
            "redirect_network_offer_url_id": 0
        }
    ]
}