H!HOPPA
GET/api/v2/referrals/analytics

Business-intelligence view: funnel, leaderboard, cost, weekly series, program stats, exclusions and contribution (defaults: all programs, last 90 days, top 10).

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
programId (query)string (uuid)No
from (query)string (date-time)No
to (query)string (date-time)No
top (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Fromstring (date-time)Yes
Tostring (date-time)Yes
CurrencystringYes
FunnelReferralFunnelResponseYesAcquisition funnel over relationships attributed in the period. Rates are 0–100.
Leaderboardarray of ReferralLeaderboardEntryResponseYes
CostReferralRewardCostResponseYes
Weeklyarray of ReferralWeeklySeriesPointResponseYes
Programsarray of ReferralProgramStatsResponseYes
Exclusionsarray of ReferralExclusionStatResponseYes
FeesCollectedunknownYes
ProviderCostunknownYes
ContributionunknownYes
AverageTopupPerQualifiedFriendunknownYes
AverageRewardPerQualifiedFriendunknownYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/analytics" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.