The Referral Tracker API allows you to monitor and analyze referral events in your Wix site's referral program.
With the Referral Tracker API, you can:
- Get a referral event to retrieve details about a specific referral event.
- Query referral events to filter and retrieve multiple referral events.
- Get referral statistics to obtain overall metrics about your referral program.
For more information about managing loyalty programs, see the Loyalty API. To learn more about referral programs, see Managing Your Referral Program.
It's important to note the following points before starting to code:
- To use the Referral Tracker API, you need to have the Wix Loyalty Program app installed on your site.
- The Referral Tracker API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.
- You must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or the new Wix Restaurants ordering app.
- Referral Event: A record of an action related to your referral program, such as a signup or a successful referral.
- Referring Customer: A customer who refers friends to your site.
- Referred Friend: A person who signs up or takes an action on your site after being referred by a customer.
- Referral Statistics: Overall metrics about your referral program's performance.
- Referral Reward: A benefit given to either the referring customer or the referred friend for participating in the referral program.
- Trigger: The specific action that initiates a referral event, such as a signup or a purchase.
- Reward Type: The type of benefit given for a successful referral, which can be a coupon, loyalty points, or no reward.