New documentation: how to use the campaign feature to track newsletters #604

mattab opened this Issue Mar 10, 2009 · 14 comments

4 participants

Piwik Open Source Analytics member
  • See new [Tracking Campaigns](
  • [URL Builder tool](
  • Official piwik campaign parameters names are now: pk_campaign and pk_kwd (consistent with cookie prefix, better than piwik_ prefix)
  • New FAQ: [“Does Piwik support Google Analytics campaign parameters (utm_campaign, utm_medium, utm_source, utm_term)?”](
  • New FAQ: [“How do I customize the Piwik Campaign parameters pk_campaign and pk_kwd?” ](
Piwik Open Source Analytics member

Very useful to track different visits from various medium, sources. For example on the page [great barrier reef]( a piwik user uses it to track twitter VS facebook VS standard search engine results VS adwords!


hi, i searched for a way to track links from a newsletter this way an it does it fine for me!
but for a better presentation in actions/sites i use 'setCustomUrl' and then the paramter
?piwik_campaign won't work anymore. got any idea for a solution ?



heinetz: please don't use Trac for technical support questons. I believe I've answered your question in the forum already.

Piwik Open Source Analytics member

heinetz, see #1198

Piwik Open Source Analytics member

Documentation written by idw in #1164 (should be updated when all tickets from #1042 are done)


You can use campaigns to monitor how effective links you send out through things like your email list or twitter. Campaigns allow you to add an extra bit of information to any link you make to your site that will let Piwik recognize visitors who have followed that link.

For example, you launch a big marketing campaign for summer. Instead of sending out links you would send out a link to

Note: If the address you want to link to already includes a ? you should replace the ? before piwik_campaign with an &. For example: becomes becomes

You do not need to configure campaigns names in advance. Just use them in a link and visitors following those links will be tracked as campaign referrers and you will be able to monitor them in the Campaigns screen under the Referrers section of Piwik:


To add a little more precision to the tracking you can specify different channels for your campaign by adding a second parameter so your link might read

If you use keywords, you will be able to click on the name of the campaign to see the campaign referrers broken down by keyword. In this example, the summer campaign has had two visitors, one via the newsletter keyword and one with no keyword:


You will probably want to know more about your campaign visitors than just how many there were. The More metrics button, second from the left under the table and highlighted in red below, will help you understand what those visitors did on your site:


= Advanced Configuration =
If you would prefer not to have piwik_campaign and piwik_kwd in your links you can change the names of these parameters in Piwiks configuration file. Your Piwik installation will have a subdirectory called config and in that subdirectory is a file called config.ini.php. If you add the following lines to the bottom of that file then you will be able to use x and y in place of piwik_campaign and piwik_kwd:

campaign_var_name = x
campaign_keyword_var_name = y

You do not have to use x and y. You can use whatever is convenient for you.

Piwik Open Source Analytics member

(In [4571]) Fixes #604, #1042

Piwik Open Source Analytics member
@mattab mattab added this to the 1.x - Piwik 1.x milestone Jul 8, 2014


I need to get the revenue from the newsletter campaign in the shopping site (built in magento).

I am getting the visitor counts in piwik, But not able to get the revenue from each newsletter campaign in piwik.

Can anybody help me to do it.

Piwik Open Source Analytics member

@shogunjames to get the revenue for each of your newsletter, go to Goals > click on your goal, then look down to "View goals by referrer type / by campaign". It should show the revenue for each Goal of your referrer (including newsletter)


Hi mattab ,

Thanks for the reply.

You mean , I need to go to "Ecommerce & Goals" tab in piwik, And select "View goals by Referrers " , there I can see the Campaigns section. There the number of visitors is showing correctly, But I am not getting the revenue. I have not created any goals manually. Is there any need to create goal by me?

I have made this done by clicking from the newsletter like this


Now the click status is showing correctly, but I dont know how to track the revenue , if they have brought anything from the magento shop site.

Could you please help me on this.

Piwik Open Source Analytics member

@shogunjames Ok please create a new report here on github (as this issue here was closed long time ago). in your issue please attach screenshot of the whole Ecommerce report page if possible. we will investigate, it could be a bug (also make sure you use 2.13.1 as some bug related to this were fixed recently)


Hi Mattab,

Thank you for your reply,

I have attached a screenshot from my piwik insttalation where I am checking the campaign status.

I am using a magento site for ecommerce activities , and we are sending newlstters to our customers.

I need to get the revenue I got from each newsletter , when they came to the site by clicking the urls in the newsletter and when they purchase a product.

I hope it is clear for you.

Also I have enabled ecommerce for my magento site and installed piwik ecommerce extension in my site. This is the piwik code which is on the source code of the success page after the order is placed.


var pkBaseURL = (("https:" == document.location.protocol) ? "piwiksiteurl" : "piwikurl");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 1);

} catch( err ) {}

This is the screenshot :


My current piwik version is 2.1.0 . Should I need to upgrade this? If I upgrade will I get the total revenue from each newsletter I send out?



I have piwik ( version : 2.13.1) installed. I am using a magento store. I have installed piwik ecommerce tracking extension in magento to track the ecommerce order in piwik. I also managed to get the revenue from campaign too. But after one month , it stopped working.

I am using the following url from campaign :

[store porduct page url]?pk_campaign=june16&pk_kwd=odernow

to track the campaign revenue, and it was working fine.But now the revenue is not tracking, only the number of visits is showing.

Could you please help me. I need to solve it asap.

Piwik Open Source Analytics member

@shogunjames please don't double post, you asked here already: #8113

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment