The AffiliatePress Leaderboard Addon allows you to display a dynamic leaderboard showcasing your top-performing affiliates. It highlights key performance metrics such as commissions, earnings, referral visits, and total sales, all sortable by column for easy analysis. This feature is perfect for encouraging competition and rewarding high achievers within your affiliate program.

Addon Activation

Before you can use the leaderboard functionality, make sure the following steps are completed:

1. Activate the AffiliatePress Pro plugin.
2. Enable the AffiliatePress Leaderboard Addon.

Once activated, you’re ready to integrate and customize the leaderboard on your site.

Why Use the Leaderboard?

Displaying an affiliate leaderboard on your website serves multiple purposes:

• Motivates affiliates to increase their performance.
• Encourages healthy competition.
• Publicly recognizes top contributors.
• Drives higher sales and affiliate engagement.

image

How to Add the Affiliate Leaderboard

To embed the leaderboard on your site:

1. Create or edit a page in your WordPress admin area.
2. Paste the following shortcode into the content area:
   [affiliatepress_affiliate_leaderboard]

3. Publish or update the page.

Once live, the leaderboard will automatically populate with the top 10 affiliates of all time, based on their total earned commission.

Customizing the Leaderboard with Shortcode Parameters

The leaderboard is highly flexible and can be tailored using several parameters within the shortcode. Here’s a breakdown of all available options:

limit – This represents the number of affiliates you wish to showcase. For example, instead of the default 10, you can add 25, to show your top 25 affiliates.

date – Filters the leaderboard by a specific time range. Useful for monthly or weekly contests.

Available options:

• this_month
• last_month
• this_week
• last_week
• this_year
• last_year

Example: Show top affiliates for the current month:
[affiliatepress_affiliate_leaderboard date="this_month"]

columns – Select which affiliate data to display in the leaderboard. Options include:

• username
• affiliate_name
• commissions_count
• commissions_amount
• visits

Example: Show all available columns:
[affiliatepress_affiliate_leaderboard columns="username,affiliate_name,commissions_count,commissions_amount,visits"]

orderby – Set the sorting logic for the leaderboard. Choose the metric by which the affiliates should be ranked.

Example: Rank affiliates by the number of referral visits:
[affiliatepress_affiliate_leaderboard columns="affiliate_name,commissions_amount,visits" orderby="visits"]

You can also combine multiple shortcode parameters, providing you with greater flexibility to tailor the leaderboard to your specific needs.

Combining Parameters

You can mix and match multiple parameters in a single shortcode to achieve a highly customized leaderboard display.

Example: Show the top 15 affiliates of the current year, ranked by commissions count: [affiliatepress_affiliate_leaderboard limit="15" date="this_year" orderby="commissions_count" columns="affiliate_name,commissions_count,commissions_amount"]