{module_affiliateprogram}

Description

Displays stats for an affiliate in an Affiliate Program.

Syntax

{module_affiliateprogram id="" render="item" collection="my_custom_collection_name" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • id - the ID of the affiliate program
  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • collection - use this if you need to access the module's Liquid output tags
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • the affiliate program list layout - on this layout you can use either the legacy tags or Liquid output tags. Here is a list of all the tags you can use the Affiliate Program reference page
  • your own custom layout - take a look at the custom templates article for more details
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Legacy tag Description
{{affiliateLink}} {tag_affiliatelink}The link for this affiliate to use on his/her website or forward to friends for tracking purposes.
{tag_actiontotal,actionTypeId,days}Total number of actions for the last x days. the Action type ID's are as follows:
  • (Inquiries) WebForm = 2
  • Purchase = 3
  • Quote = 4
  • SecureZoneLogin = 5
  • EmailListSubscribe = 6
  • EmailListSubscribeDoubleOptIn = 12
  • EProductDownload = 7
  • ReferAFriend = 8
  • BookingForm = 9
  • EmailListUnsubscribe = 10
  • CampaignOpen = 11
  • CampaignLinkClick = 13
  • ForumNewTopic = 14
  • ForumNewPost = 15
{{clickThrusTotal}} {tag_clickthrustotal}Total click-thrus via the affiliate link
{{commissionOwing}} {tag_commissionowing}Commission owing to the affiliate logged into the secure zone
{{referralsLastMonth}} {tag_referralslastmonth}Referrals made last month by the affiliate logged into the secure zone
{{referralsLastWeek}} {tag_referralslastweek}Referrals made last week by the affiliate logged into the secure zone
{{referralsToday}} {tag_referralstoday}Referrals made today by the affiliate logged into the secure zone
{{referralsTotal}} {tag_referralstotal}Total number of referrals made by the affiliate logged into the secure zone

Examples

  • {module_affiliateprogram id="1429"} -this will list the details of the affiliate program with the ID 1429
  • {module_affiliateprogram id="335" collection="my_custom_collection_name" template="/folder/template.tpl"} - in this case nothing will be displayed, however the affiliate program details will become available in the custom1 collection.

Syntax

{module_affiliateprogram,id}

Parameters

  • id - the ID of the affiliate program

Layouts

Examples

{ module_affiliateprogram,1429}