The Referral Tracker API allows you to monitor and analyze referral events in a 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 a 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, a site needs to have the Wix Loyalty Program app installed.
- The Referral Tracker API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.
- A site must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or Wix Restaurants Orders.
- Referral event: A record of an action related to a referral program, such as a signup or a successful referral.
- Referring customer: A site member who shares a referral URL with potential new customers.
- Referred friend: A person who signs up or takes an action on your site after being referred by a referring customer.
- Referral statistics: Overall metrics about a referral program's performance.
- Referral reward: A benefit given to either the referring customer or the referred friend for participating in a 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.