Api Model:OfferPixel

From HasOffers

Contents

Required Parameters

  • id
    • Values: (int)
  • offer_id - Id of offer. Use 0 for global pixel (displayed on all offers).
    • Values: (int)
  • affiliate_id - Id of affiliate.
    • Values: (int)
  • type - Type should be supported by the advertiser conversion tracking pixel placed. Refer to table below for compatibility. Default 'code'.
    • Values: url, code, image
  • code - Valid URL if type parameter is set to 'url', otherwise HTML code.
    • Values: (string)
  • status - Default 'pending'.
    • Values: active, pending, deleted, rejected

Optional Parameters

  • goal_id - Id of goal
    • Values: (int)

Dynamic Code Variables

Optional variables that can be included in the offer_url and replaced before redirection.

  • Affiliate ID - Include {affiliate_id} and it will be replaced by the ID of the Affiliate promoting the offer.
  • Affiliate Sub ID - Include {aff_sub} and it will be replaced by the value of Affiliate Sub ID passed in via an affiliate tracking link.
  • Affiliate Sub ID 1 - Include {aff_sub1}, alias for Affiliate Sub ID
  • Affiliate Sub ID 2 - Include {aff_sub2} and it will be replaced by the value of Affiliate Sub ID 2 passed in via an affiliate tracking link.
  • Affiliate Sub ID 3 - Include {aff_sub3} and it will be replaced by the value of Affiliate Sub ID 3 passed in via an affiliate tracking link.
  • Affiliate Sub ID 4 - Include {aff_sub4} and it will be replaced by the value of Affiliate Sub ID 4 passed in via an affiliate tracking link.
  • Affiliate Sub ID 5 - Include {aff_sub5} and it will be replaced by the value of Affiliate Sub ID 5 passed in via an affiliate tracking link.
  • Affiliate Source - Include {source} and it will be replaced by the value of Affiliate Source passed in via an affiliate tracking link.
  • Offer ID - Include {offer_id} and it will be replaced by the ID of the Offer.
  • Offer URL ID - Include {offer_url_id} and it will be replaced by the ID of the Offer URL used.
  • Advertiser ID - Include {advertiser_id} and it will be replaced by the ID of the Advertiser of the offer.
  • Customer ID - Include {customer_id} and it will be replaced by the ID of the Custom for the subscription.
  • Offer Reference ID - Include {offer_ref} and it will be replaced by the Reference ID of the offer.
  • Affiliate Reference ID - Include {affiliate_ref} and it will be replaced by the Reference ID of the Affiliate promoting the offer.
  • Advertiser Reference ID - Include {advertiser_ref} and it will be replaced by the Reference ID of the Advertiser of the offer.
  • Payout - Include {payout} and it will be replaced by the payout for the Affiliate.

Offer Pixel Type Compatibility

Offer Pixels must be added based on the conversion tracking protocol of each offer.

  • Offer protocol - 'http' / 'https'
    • OfferPixel type: 'code' *Only HTTPS pixels for 'https' offer protocol.
    • OfferPixel type: 'image' *Only HTTPS pixels for 'https' offer protocol.
    • OfferPixel type: 'url'
  • Offer protocol - 'http_img' / 'https_img'
    • OfferPixel type: 'image' *Only one per affiliate / offer combination and HTTPS image pixels for 'https_img' offer protocol.
    • OfferPixel type: url'
  • Offer protocol - 'server' / 'server_affiliate'
    • OfferPixel type: 'url'


If an OfferPixel type is not listed for an Offer Protocol then it is not supported.

 
Email this page to a friend or co-worker