Get my referral summary
GET
/me/referrals/summary
The ambassador portal's headline: totals, the click-to-gift funnel and a daily series for the caller's own referral links over a window (default: the 28 days ending to). Every portal route reads only the session's own rows.
Requires permission: view_own_referral_portal.
Authorizations
BearerAuth
In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.
Type
HTTP (bearer)
Parameters
Query Parameters
from
Window start. Defaults to 28 days before to. Must be before to and not earlier than 2020-01-01.
Type
string
Format
"date-time"to
Window end. Defaults to now.
Type
string
Format
"date-time"Responses
The summary
application/json
JSON
{
"data": "string",
"range": "string"
}