GET/api/v2/users/{userId}/referrals/links/{linkId}/performance

Clicks (by UTC day), sign-ups, verified, qualified and earning friends attributed through the link plus the owner's rewards on them. range = 7d | 30d | 90d | month | all.

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)integer (int32)Yes
linkId (path)string (uuid)Yes
range (query)stringNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
ClicksunknownYes
UniqueClicksunknownYes
ClickToSignupRateunknownYes
SignupsunknownYes
VerifiedunknownYes
QualifiedunknownYes
EarningunknownYes
RewardsAccruedunknownYes
RewardsPaidunknownYes
CurrencystringYes

Example request

curl -X GET "https://{base_url}/api/v2/users/{userId}/referrals/links/{linkId}/performance" \
  -H "x-api-key: YOUR_API_KEY"

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