Difference between revisions of "NATS4 Additional Tracking"
Tmm vincent (talk | contribs) m (formatting changes) |
|||
| Line 1: | Line 1: | ||
== Feature Summary == | == Feature Summary == | ||
| − | + | NATS versions 4.1.7.1 and above offer the ability to allow your affiliates to add additional passthrough variables in their linkcodes which will be stored with a member's subscription record. These variables become available on postbacks. In addition to these passthroughs, methods for forcing the join option to be used on the join form and changing the default join option have also been added. | |
| − | In addition to these passthroughs, methods for forcing the join option to be used on the join form and changing the default join option have also been added. | ||
| − | < | + | <span style="color:red">'''These additional tracking features can only be used if you allow them within their "Edit Affiliate Admin Settings" page. The two settings are called "Subscription Passthrough Variables in Linkcodes", and "Force Join Option in Linkcodes". Once you enable the feature for their account, they can add a "nats_at" array with the additional variables to the end of a link code.'''</span> |
== Join Option Variables == | == Join Option Variables == | ||
| − | You can force a specific join option on the join form by passing the following variable in the URL:< | + | You can force a specific join option on the join form by passing the following variable in the URL: <code>nats_at[force_optionid]={Option ID}</code> |
| − | + | ||
| − | nats_at[force_optionid] | + | You can change the default join option on the join form by passing the following variable: <code>nats_at[default_optionid]={Option ID}</code> |
| − | </ | ||
| − | You can change the default join option on the join form by passing | ||
| − | |||
| − | nats_at[default_optionid] | ||
| − | </ | ||
== Subscription Passthrough Variables == | == Subscription Passthrough Variables == | ||
| − | You can add up to 5 additional subscription passthrough variables that will | + | You can add up to 5 additional subscription passthrough variables that will be stored with the member's subscription: |
| + | |||
<pre> | <pre> | ||
| − | nats_at[subscription_passthrough1] | + | nats_at[subscription_passthrough1]={Passthrough Data 1} |
| − | nats_at[subscription_passthrough2] | + | nats_at[subscription_passthrough2]={Passthrough Data 2} |
| − | nats_at[subscription_passthrough3] | + | nats_at[subscription_passthrough3]={Passthrough Data 3} |
| − | nats_at[subscription_passthrough4] | + | nats_at[subscription_passthrough4]={Passthrough Data 4} |
| − | nats_at[subscription_passthrough5] | + | nats_at[subscription_passthrough5]={Passthrough Data 5} |
</pre> | </pre> | ||
| Line 29: | Line 24: | ||
== Additional Parameters == | == Additional Parameters == | ||
| − | If you need to ensure that any existing passthroughs are not used | + | If you need to ensure that any existing passthroughs are overwritten and not used (passthroughs are stored based on the surfer's IP & session), add the following parameter to the track link: <code>nats_at[clear_existing_values]=1</code> |
== Additional Notes == | == Additional Notes == | ||
Example link: | Example link: | ||
| − | < | + | |
| − | + | <code><nowiki>https://{Link Domain}/track/{NATSCode}/?nats_at[force_optionid]={Option ID}&nats_at[default_optionid]={Option ID}&nats_at[subscription_passthrough1]={Passthrough Data 1}&nats_at[subscription_passthrough2]={Passthrough Data 2}</nowiki></code> | |
| − | </ | + | |
| − | The tracking is site specific. Going through a link code resets it. | + | The tracking is site specific. Going through a link code resets it. |
Revision as of 00:19, 15 March 2019
Feature Summary
NATS versions 4.1.7.1 and above offer the ability to allow your affiliates to add additional passthrough variables in their linkcodes which will be stored with a member's subscription record. These variables become available on postbacks. In addition to these passthroughs, methods for forcing the join option to be used on the join form and changing the default join option have also been added.
These additional tracking features can only be used if you allow them within their "Edit Affiliate Admin Settings" page. The two settings are called "Subscription Passthrough Variables in Linkcodes", and "Force Join Option in Linkcodes". Once you enable the feature for their account, they can add a "nats_at" array with the additional variables to the end of a link code.
Join Option Variables
You can force a specific join option on the join form by passing the following variable in the URL: nats_at[force_optionid]={Option ID}
You can change the default join option on the join form by passing the following variable: nats_at[default_optionid]={Option ID}
Subscription Passthrough Variables
You can add up to 5 additional subscription passthrough variables that will be stored with the member's subscription:
nats_at[subscription_passthrough1]={Passthrough Data 1}
nats_at[subscription_passthrough2]={Passthrough Data 2}
nats_at[subscription_passthrough3]={Passthrough Data 3}
nats_at[subscription_passthrough4]={Passthrough Data 4}
nats_at[subscription_passthrough5]={Passthrough Data 5}
Keeping these variables in the URL after redirect
By default, the nats_at array will not available in the URL after the tracking redirect. It is still stored with the subscription and will become available on postbacks. You can control this behavior with the configuration "REMOVE_EXTRA_QUERY_TRACKING_VARS" which can be found in the "Surfer" section of the configuration admin.
Additional Parameters
If you need to ensure that any existing passthroughs are overwritten and not used (passthroughs are stored based on the surfer's IP & session), add the following parameter to the track link: nats_at[clear_existing_values]=1
Additional Notes
Example link:
https://{Link Domain}/track/{NATSCode}/?nats_at[force_optionid]={Option ID}&nats_at[default_optionid]={Option ID}&nats_at[subscription_passthrough1]={Passthrough Data 1}&nats_at[subscription_passthrough2]={Passthrough Data 2}
The tracking is site specific. Going through a link code resets it.
