API V1 RESOURCES LINKS

Referral Stats

Referral Stats Attributes

field type description
clicks integer Number of people who have clicked on the link
signups integer Number of people who have signed up from the link
amount_earned float How much credit has been added to the account
url string User’s referral link

Example object:

{
	"referral_stats": {
		"clicks": "165",
		"signups": 23,
		"amount_earned": 10.5,
		"url": "https://sclng.io/r/81e0166feda0efe0"
	}
}

Display Your Referral Statistics

GET https://$SCALINGO_API_URL/v1/account/referrals/stats

Display the statistics of your referral link.

Example

curl -H "Accept: application/json" -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BEARER_TOKEN" \
  -X GET https://$SCALINGO_API_URL/v1/account/referrals/stats

Returns 200 OK

{
	"referral_stats": {
		"clicks": "165",
		"signups": 23,
		"amount_earned": 10.5,
		"url": "https://sclng.io/r/81e0166feda0efe0"
	}
}