Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Smart Links

Get Smart Link by ID

get/networks/campaigns/{campaignId}

Path parameters

campaignIdinteger required

The smart link (campaign) identifier.

Query parameters

relationship'reporting' | 'redirects' | 'offers' | 'catch_all_offer_basic'

Include related data. Repeat for multiple relationships.

Response

network_campaign_idinteger

Unique smart link (campaign) ID.

network_idinteger

Network ID.

campaign_namestring

The displayed name of the smart link.

campaign_status'active' | 'paused' | 'deleted'

Status of the smart link.

network_tracking_domain_idinteger

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

is_use_secure_linkboolean

Whether SSL is forced on tracking links.

redirect_routing_type'priority' | 'weight' | 'kpi'

Determines how the Smart Link traffic is distributed between the listed offers. kpi automatically delivers traffic ranked by the best performing offers for your set KPI. priority checks the first position and continues downward if the user doesn't match targeting/cap. weight delivers traffic with a percentage split between eligible offers.

catch_all_network_offer_idinteger

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if the 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_affiliatesboolean

Whether the smart link is visible to affiliates. If enabled, the Smart Link will be visible to the partner only if all the offers in the redirect tree are runnable by the partner.

run_frequency'unknown' | '1_hours' | '3_hours' | '6_hours' | '12_hours' | '24_hours'

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Required if redirect_routing_type is set to kpi.

metric'unknown' | 'profit' | 'cvr' | 'evr' | 'conversions' | 'payout' | 'revenue' | 'rpc' | 'cpc' | 'epc'

The metric used 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. Required if redirect_routing_type is set to kpi.

optimization_goalnumber

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

data_lookback_window'unknown' | '12_hours' | '24_hours' | '48_hours'

Determines the period of data used for evaluating how offers are performing at your set Metric. Can be 12_hours, 24_hours, or 48_hours. Required if redirect_routing_type is set to kpi.

data_collection_thresholdinteger

The amount of data (in clicks) 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.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "network_campaign_id": 1,
  "network_id": 1,
  "campaign_name": "My Smart Link",
  "campaign_status": "active",
  "network_tracking_domain_id": 1,
  "redirect_routing_type": "weight",
  "catch_all_network_offer_id": 57,
  "run_frequency": "unknown",
  "metric": "unknown",
  "data_lookback_window": "unknown",
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "redirects": {
      "entries": [
        {
          "network_campaign_redirect_id": 6,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 11,
          "routing_value": 1
        }
      ]
    }
  }
}