Skip to content

List campaigns I referred to​

GET
/me/referrals/campaigns

Per-campaign clicks, visitors, driven gifts and money raised from the caller's referral links in the window.

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 campaigns

application/json
JSON
{
"data": [
{
"fundraiser_id": "string",
"fundraiser_title": "string",
"fundraiser_slug": "string",
"clicks_human": 0,
"clicks_bot": 0,
"clicks_unknown": 0,
"distinct_human_visitors": 0,
"driven_gifts": 0,
"raised_cents": 0,
"last_click_at": "string"
}
],
"range": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress