GET
/api/v2/users/{userId}/referrals/analyticsThe user's own referral performance over a period: conversion journey, totals, weekly trend and top friends (pseudonymised). range = 7d | 30d | 90d | month (default 30d); explicit from/to (ISO, UTC, to exclusive, at most 366 days) win over range.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes | |
| programId (query) | string (uuid) | No | |
| range (query) | string | No | |
| from (query) | string (date-time) | No | |
| to (query) | string (date-time) | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| From | string (date-time) | Yes | |
| To | string (date-time) | Yes | |
| Range | string | Yes | |
| Currency | string | Yes | |
| GeneratedAt | string (date-time) | Yes | |
| Journey | ReferralJourneyResponse | Yes | Conversion journey of the friends attributed in the period. Counts are cumulative like the admin funnel: a friend counts in every stage up to the furthest one reached (Invited ⊇ Verified ⊇ CardIssued ⊇ Qualified), and Earning + WindowEnded split Qualified by whether the top-up commission window is still open. |
| Totals | ReferralMemberTotalsResponse | Yes | Attributed/Qualified cover the friends attributed in the period (ConversionRate = Qualified / Attributed, 0..1, 4 dp). Reward figures cover the member's rewards whose event occurred in the period: Accrued = every reward not withdrawn (cancelled, reversed, failed or expired), Paid = the part already paid, Pending = Accrued − Paid. |
| Weekly | array of ReferralMemberWeeklyPointResponse | Yes | |
| TopFriends | array of ReferralTopFriendResponse | Yes | |
| Campaigns | array of ReferralMemberCampaignResponse | Yes |
Example request
curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/analytics" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.