Referrals

Get referral funnel stats

Returns referral funnel counts: clicks, attributed_signups, qualified_referrals, review_required, rewarded_referrals, capped_referrals and rejected_referrals, plus signup_rate, qualification_rate and reward_rate. Narrow them with from and to (RFC 3339) and campaign (UTM campaign).

get/admin/referrals/stats

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/admin/referrals/stats
  • Auth: API key in header x-api-key

Query parameters

fromstring

Lower bound in RFC3339 format

tostring

Upper bound in RFC3339 format

campaignstring

Filter by UTM campaign

Headers

x-api-keystring required

Admin API key

Response

Referral funnel stats

attributed_signupsinteger
capped_referralsinteger
clicksinteger
qualification_ratenumber
qualified_referralsinteger
rejected_referralsinteger
review_requiredinteger
reward_ratenumber
rewarded_referralsinteger
signup_ratenumber

Example response

{
  "attributed_signups": 9,
  "clicks": 42,
  "qualification_rate": 0.333,
  "qualified_referrals": 3,
  "review_required": 1,
  "reward_rate": 0.222,
  "rewarded_referrals": 2,
  "signup_rate": 0.214
}

Changes

No recorded changes to this operation across all 2 revisions of this API.