Smart Links params reference
Link params is a container for predefined parameters used by GetSocial and any custom key-value pairs you want to attach to the SmartLink. You can specify link params during link creation, override them via URL query parameters and receive them from the SDKs or via webhook events.
The table below gives an explanation of predefined link parameters and their availability during creation and receiving.
Notes:
* - Indicates that property is mandatory to provide during creation.** - Indicates that property is always present on the receiver side.- On the receiver side link param will be present ONLY if it was provided during the creation time or overridden via query parameter. Parameter WILL NOT be present on the receiver side if the default value was used.
General params
| Param |
Description |
Defaults |
Creation from Dashboard |
Creation from API |
Overrides from SDKs |
Overrides query param |
Receiving referral data from mobile SDKs |
Receiving on webhook events |
|
| $token |
The token of the link the user clicked on, e.g qwe123 if the link was https://myapp.gsc.im/qwe123. |
Autogenerated |
✅ |
✅as request field |
❌ |
❌ |
** ✅ as referral data field |
** ✅in link params |
|
| $link_name |
Name of the Smart Link displayed on the Dashboard. |
Mandatory |
* ✅ |
* ✅as request field |
❌ |
❌ |
✅in link params |
✅in link params |
|
| $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. |
Empty |
❌ |
❌ |
❌ |
✅append as url path |
✅in link params |
✅in link params |
|
| Custom data |
You can add any custom key-value parameters to the link params during the creation and receive them from the SDK and webhook events. Custom data keys can not start from $ |
Empty |
✅ |
✅as link param |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
|
Analytics params
| Param |
Description |
Defaults |
Creation from Dashboard |
Creation from API |
Overrides from SDKs |
Overrides query param |
Receiving referral data from mobile SDKs |
Receiving on webhook events |
| $campaign_id |
ID of the campaign the Smart Link belongs to. |
Autogenerated |
❌ |
❌ |
❌ |
❌ |
✅in link params |
✅in link params |
| $campaign_name |
Name of the campaign the Smart Link belongs to. |
Mandatory |
* ✅ |
* ✅as request field |
❌ |
❌ |
✅in link params |
✅in link params |
| $channel |
Channel used (e.g whatsapp, sms) for invites or a Smart Link campaign. |
Mandatory |
* ✅ |
* ✅as request field |
✅as link param |
✅as query param |
** ✅ as referral data field |
** ✅in link params |
| $medium |
Campaign medium. |
Empty |
✅ |
✅as request field |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
Landing page params
| Param |
Description |
Defaults |
Creation from Dashboard |
Creation from API |
Overrides from SDKs |
Overrides query param |
Receiving referral data from mobile SDKs |
Receiving on webhook events |
| $title |
Landing page title |
Taken from Landing Page config on the Dashboard |
❌Dashboard provide a way to customize (and localize) title during link creation but not via link params |
❌API provide a way to customize (and localize) title during link creation but not via link params |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $description |
Landing page description |
Taken from Landing Page config on the Dashboard |
❌Dashboard provide a way to customize (and localize) description during link creation but not via link params |
❌API provide a way to customize (and localize) description during link creation but not via link params |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $image |
Landing page featured image |
Taken from Landing Page config on the Dashboard |
❌Dashboard provide a way to customize image during link creation but not via link params |
❌API provide a way to customize image during link creation but not via link params |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $youtube_video |
The link to the YouTube video that can replace image on the landing page |
Taken from Landing Page config on the Dashboard |
❌ |
❌API provide a way to customize youtube video during link creation but not via link params |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
Link redirection behaviour
| Param |
Description |
Defaults |
Creation from Dashboard |
Creation from API |
Overrides from SDKs |
Overrides query param |
Receiving referral data from mobile SDKs |
Receiving on webhook events |
| $redirect_url |
If set, all clicks on all platforms will be redirected to this URL |
Taken from link behaviour config on the Dashboard |
✅as link param |
✅as link param |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $ios_redirect_url |
If set, when app is not installed all clicks made on iOS devices will be redirected to this URL |
Taken from link behaviour config on the Dashboard |
✅as link param |
✅as link param |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $android_redirect_url |
If set, when app is not installed all clicks made on Android devices will be redirected to this URL |
Taken from link behaviour config on the Dashboard |
✅as link param |
✅as link param |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
| $desktop_redirect_url |
If set, all clicks made on desktop will be redirected to this URL |
Taken from link behaviour config on the Dashboard |
✅as link param |
✅as link param |
✅as link param |
✅as query param |
✅in link params |
✅in link params |
Referral data params
All referral data params are added by GetSocial automatically to indicate various properties of the event attribution.
| Param |
Description |
Receiving referral data from mobile SDKs |
Receiving on webhook events |
| $guaranteed_match |
true if the referral data is guaranteed to be correct. |
** ✅ as referral data field |
** ✅in link params |
| $first_match |
true if this is the first install of this app from this device. Mutually exclusive with $reinstall. |
** ✅ as referral data field |
** ✅in link params |
| $first_match_link |
true if this link was attributed for the first time from this device. |
** ✅ as referral data field |
** ✅in link params |
| $reinstall |
true if this is an install, but not the first one from this device. Mutually exclusive with $first_match. |
** ✅ as referral data field |
** ✅in link params |
| $referrer_user_guid |
GetSocial user ID of the referring (sender) user. Always available for links created as part of Smart Invites |
✅ as referral data field |
✅in link params |
| $referrer_user_idfa |
Advertising ID of the referring (sender) user. Always available for links created for Smart Invites |
✅in link params |
✅in link params |
Give us your feedback! Was this article helpful?
😀
🙁