*Note: This article is an extension to our main instructions on setting up a referral tracking script outlined in this article.
The Roster referral tracking script has the capability to track referral link clicks using a custom URL parameter. This can be useful for various situations including:
When you're moving from a different affiliate/referral platform to Roster and you need to continue tracking with referral links you already have distributed.
You've integrated your online store/website with another 3rd party platform that requires a specific referral link parameter
You want your referral link to better represent your branding
For example, if your current default brand referral link is https://mydomain.com?rstr={referral_id} and you want to change it to https://mydomain.com?referrer={referral_id}. Follow these steps to get setup...
Step 1: Change Your Brand Settings
To setup a custom referral link URL parameter contact our support team to let us know the name of the new parameter you'd like to use. In the above example, we're using "referrer" in place of "rstr".
Our support team will change your referral link URL parameter to "referrer" (or something else you prefer) so that this is now reflected in all places where a referral link is displayed in the Roster applications.
Step 2: Update your top level tracking script
As explained in the main installation article in step 2, you need to further modify that script by including the custom-param-name in the script src value. If you have other URL params added to your script (ie: cookie tracking) you need to keep those there and only add this new parameter.
Here's an example of how to do this:
<!-- Roster Analytics -->
<script async type="application/javascript" src="https://sa.getroster.com/sa.js?token=ACCESS_TOKEN&custom-param-name=PARAM_NAME"></script>
*Set your Access Token: be sure to replace the ACCESS_TOKEN placeholder with your public access token.
*Set your custom param name: be sure to replace the PARAM_NAME placeholder with your custom name. For example: &custom-param-name=referrer
Step 3. End to End Testing
You're done! Next it's time to test and verify things are setup properly.
View this article for steps on how to test your referral tracking script installation.