Referral Data Reference

When you receive referral data (either from our mobile SDKs, or via webhooks) you receive a map of key/value pairs. This map contains any custom data you’ve provided during link creation and also metadata added by GetSocial.

All keys with the $ prefix are reserved by GetSocial. These keys may or may not appear in the referral data, depending on link type, attribution method and customization. Current keys are listed below:

Key Explanation
$referrer_user_guid GetSocial user ID of the referring user.
$referrer_user_idfa Advertising ID of the referring user.
$token The token of the link the user clicked on, e.g qwe123 if the link was https://myapp.gsc.im/qwe123.
$title Overriden title used on the landing page (see overrides). Not present if not overriden.
$description Overriden description used on the landing page (see overrides). Not present if not overriden.
$image Overriden image used on the landing page (see overrides). Not present if not overriden.
$channel Channel used (e.g whatsapp, sms) for invites or a Smart Link campaign.
$medium Campaign medium. Available for Smart Links created from the Dashboard. Can be overridden.
$campaign_id ID of the campaign the Smart Link belongs to.
$campaign_name Name of the campaign the Smart Link belongs to.
$link_name Name of the Smart Link created from the Dashboard. Is not present otherwise.
$custom_path Custom path specified in the URL, e.g foo/bar if the link was https://myapp.gsc.im/<token>/foo/bar. See here for details.
$redirect_url If set, all clicks will be redirected to this URL (see overrides).
$guaranteed_match "true" if the referral data is guaranteed to be correct.
$first_match "true" if this is the first install of this app from this device. Mutually exclusive with $reinstall.
$first_match_link "true" if this link was attributed for the first time from this device.
$reinstall "true" if this is an install, but not the first one from this device. Mutually exclusive with $first_match.
$youtube_video Overriden Youtube video URL (see overrides). Not present if not overriden.

Give us your feedback! Was this article helpful?

😀 🙁