UTM Aliasing - activitystream/asa.js GitHub Wiki

Imagine you've already integrated with some campaign tracking infrastructure that doesn't use the classic UTM fields. This could be tagging structures like Piwik, Mailchimp, Adobe Analytics, or something else. As Activity Stream is set up to look for UTM tags it won’t recognize the tagging you’re using, but here’s a useful little feature: UTM aliasing.

Example:

asa('set.utm.aliases', {
  utm_campaign: ['my_campaign_param'],
  utm_source: ['my_source_param']
});

The snippet above would tell asa:

When looking for utm_campaign, if you don’t find it try looking for my_campaign_param in the URL instead and use that in its place. Similarly, look for my_source_param when looking for utm_source, (if you don’t find it)

All five UTM fields can be aliased:

field	description
utm_source	Identifies which site sent the traffic
utm_medium	Identifies what type of link was used, such as cost per click or email.
utm_campaign	Identifies a specific product promotion or strategic campaign
utm_term	Identifies search terms
utm_content	Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. It is often used for A/B testing and content-targeted ads