Retrieve referral statistics for the currently logged-in customer, including a summary of referral statuses and individual referral details.
Usage
Response
Whether the request was successful.
Aggregated referral statistics.
Total number of referrals made.
Referrals that haven’t been acted on yet.
Referrals where the friend has signed up but not yet completed the required action.
Fully completed referrals.
Referrals that have expired.
Number of unclaimed referral rewards.
List of individual referrals.
Email address of the referred friend.
Current status ("pending", "friend_converted", "completed", "expired").
ISO 8601 timestamp of when the referral was created.
When the referred friend placed their qualifying order, or null.
The advocate’s reward discount code, once earned, or null.
Whether the advocate has used their reward code.
When the advocate’s reward code expires, or null.
Sample response
