Referral Factory provides detailed referral analytics about the users in your referral program. You can use our API to create your own customized referral tracking dashboard to show users their referral performance, their rewards, and more...
In this guide we will show you how to create a dashboard like the one we have made for our customers 👇
Get Started Using Our API
We’ve built our API on REST principles and is designed to be a predictable and intuitive interface for interacting with your referral campaigns and the users participating in them. To use our API you will need to be on at least the Basic plan of Referral Factory. Please make sure you understand how our campaign builder works before interacting with our API, you can watch to learn here.
You must be on our basic plan or higher in order to access our API
How To Get Your API Access Token
In order to use the API, you need to be on the Basic plan or higher. Once you have upgraded your plan to get API access you will need to access your API key. To do this, log in to your Referral Factory account and click on the Settings Tab on the left-hand side.
Scroll down to view and copy your API access token.
How To Add A User From Your Database To Your Referral Campaign
Whenever you get a new customer or user registering on your platform, you will need to add them to your referral program at the same time so that they do not have to register for your referral program in order to participate. When you create a new user, you will get their USER ID in the response. You must make sure you store this USER ID on your end.
How To Make It Easy For Users To Share Their Referral Link
In the API response when you get a specific user, you can also retrieve the sharing options which you can add to your dashboard so that it is really simple for your users to access their referral link in real-time and share it on whatever social media channel they feel comfortable using.
In this response you will be able to get the following data:
Their referral link
The social channel URL that users can click on to share their link
The social sharing message that goes with the link when it is shared on social media.
How To Get The Referral Data For Each User For Your Referral Dashboard
Every time a user logs into your platform or environment, you can run one API call to get a specific user. You will need the User ID in order to do this, which is why it’s important to store the User ID.
In this response you will be able to get the following data:
Their reach
Their referral count
Their converted referrals count
How To Show Users Their Rewards
If you want to make a 'cash earned' or 'rewards earned' block like in the example below you will need to manually add that. This can be done using a simple formula or calculation, for example:
Number of converted referrals X the value of the reward = Total cash earned.
You can also use our API to do the following:
This means you can also show your users how many rewards they have that are still due to them as well as how many have already been issued.
Something to note: You may also need to bring in your creative team so that they can design a beautiful page to display your referral analytics to your users or customers.
Providing a referral dashboard for your referral program is an excellent way to be open and transparent with your users or customers About their performance and encourage them to keep participating as they can see how well they are doing and how much they have earned.