Skip to main content
GET
/
api
/
v1
/
members
/
{userId}
/
referral-stats
Get referral statistics
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/referral-stats \
  --header 'x-tenant-api-key: <api-key>'
{
  "totalReferrals": 123,
  "directReferrals": 123,
  "referralsThisMonth": 123,
  "conversionRate": 123,
  "totalCommissionFromReferrals": 123,
  "topPerformers": [
    {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "name": "<string>",
      "givenName": "<string>",
      "surname": "<string>",
      "referralCount": 123,
      "commissionGenerated": 123
    }
  ]
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Path Parameters

userId
string<uuid>
required

Response

Referral statistics

totalReferrals
integer
directReferrals
integer
referralsThisMonth
integer
conversionRate
number
totalCommissionFromReferrals
number
topPerformers
object[]