New Piwik Javascript Tracking API – How we designed it
There are a lot of changes in Piwik 0.4. Today, I’m going to write about the release of an exciting new version of piwik.js, Piwik’s JavaScript tracker. While the improvements are all under the hood, Piwik’s client-side code is now a heavyweight contender to the trackers from the “Big 3″ (i.e., GA, Y!A, and MS).
Inspired by Remy Damour’s code contribution, planning and redevelopment of piwik.js began over 9 months ago. Over this period, we continued to maintain the legacy piwik.js while developing this new and improved version. We looked at the APIs of the “Big 3″. We heard your complaints. We read your suggestions. We tackled your support requests. And after many code reviews and test cycles, we believe it’s time to unleash the code.
On behalf of the Piwik community, I’d like to thank everyone who submitted bug reports, suggestions, and input that drove this rewrite.
Highlights
The new piwik.js is:
- Object-oriented.
Multiple trackers on the same web page is now possible. And with the exception of legacy support, the code lives entirely in the Piwik namespace. - Backwards compatible.
You don’t have to update the tracking code on your pages. Note: we have deprecated piwik_track(), piwik_log(), and global variables for configuration but backward compatibility will always remain. - XHTML-friendly.
The code no longer modifies the DOM. Specifically, the calls to document.write() — to attach the transparent 1×1 web bug image or to detect plugins in Internet Explorer — are history. - Less restrictive.
The code is more forgiving about where you insert the new tracking code in your pages. Also, custom data is now JSON stringified and no longer limited to a flat structure. - Industry-conforming.
The code now tracks the click event instead of mousedown. - More customizable.
Check out the API. For example, you can now define your own CSS classes for piwik_ignore, piwik_download, and piwik_link. - Heavily tested.
We added automated unit tests via QUnit. The code also passes JSLint and (Microsoft’s) JavaScript Leak Detector.
Documentation
You can find the updated documentation for the revamped JavaScript tracking API here:
http://piwik.org/docs/javascript-tracking/
As always, we would appreciate your feedback. Thank you for using, supporting, and promoting Piwik.
This post is from Anthon Pang (aka “vipsoft”), new rockstar developer in the Piwik team.
Anthon Pang
Anthon is a Software Developer from Canada and an active Piwik team member since 2007. He has contributed some of the earliest and most critical code in Piwik, such as the Javascript Tracker. Anthon also built and maintains our QA infrastructure.
Subscribe to our rss feed:
Posts or you can Suggest a topic to write about in the blog or See list of Features
English



Pascalshow Says:
Habe keine Ahnung was ich schreiben soll, aber Hauptsache ich war hier! (Smile)
motorcyclist Says:
Would like to use Piwik on Vbulletin 3.8.x but it doesn’t look possible. They’re saying it works on 4.x, but Adsense has to be turned off.
Motorrad News Says:
Versuche mit Piwik haben zwar eine tolle Statistik erzeugt, die auch sehr umfangreich war. Aber leider taugt es nicht für stark frequentierte Seiten, wenn man den Service nicht auslastet. So kam es schon nach kurzen zu ewigen Ladezeiten, bis die Datenbank ganz aufgegeben hat. Schade.
Tom Says:
I’m using it at smaller sites.
Auto News Says:
Vielen Dank für Piwik und macht weiter so :) :) :)
Technik Magazin Says:
Für eine kostenlose Software ist es schon genial, was Piwik bietet. Mir ist bisher kein anderes Programm bekannt, was in dem Umfang soviel bietet.
Motorrad Ticker Says:
Piwik habe ich schon eine Zeit im Einsatz getestet. Ein tolles Analyse Tool, nur leider ist mein Server mit der Zeit durch die Daten in die Knie gegangen :(
Wasseradern entstören Says:
Danke für die Infos, als Rutengeher bin ich ja in einem anderen Bereich tätig, aber ich finde es sehr spannend.
Phil Says:
Piwik ist spitze, fast so gut wie Analytics …
Kosmetik Says:
Super, vielen Dank !!
Annika Says:
Hallo Piwik! Super Sache, weiter so
Bernd Says:
Danke für dein super tool! Viele Grüße, Bernd
smartpack Says:
dönerbox, pommestüten, verpackungen
smartpacl Says:
Verpackungen aller art, dönerbox
jaffimail Says:
bester webmail service , dazu auch kostenlos !
perlink Says:
bester webkatalog
Casting Models Says:
Einfach Super! Danke an Piwik.org. Es ist seht hilfreich für unsere weitere Arbeit.
matratzen Says:
Weiter so und vielen Dank für euer Service.
toner treff shop Says:
Weiter so und vielen Dank für euer Service.
Shop Sopy Says:
auch wir danken für euer Tool. Danke danke danke … …
Teko Vision Says:
Danke für euer nettes Tool. Weiter So.
hostxl suche Says:
Jetzt haben wir endlich wieder eine Vernünfige Auswertung. Danke an Piwik
schey wilhelm GbR Says:
Auch wir nutzen Piwik seit kurzem. Danke das es euch gibt.
kostenloser Webkatalog Says:
kann mich nur allen anschließen für das Tool. Gute Arbeit Jungs. Weiter So.
Spiele Spielen Says:
Ich wollte nur danke an Piwik sagen für das super Tool.
concept hamburg Says:
Großartig gemacht, Danke PIWIK !!!
Produktfilm Says:
Gelesen, getestet, als gut befunden! So solls sein! Danke schön!
Mike Chan Says:
Wieder ein Tool was sich lohnt zu testen. Ihr seid Klasse.
Royalty Free Says:
Perfekte Lösung für meine Webseite! Das Update könnte einfacher sein :-)
Karsten Says:
Endlich eine Alternative zu Analytics.
Danke dafür!
MfG Karsten
D-Lite Says:
D-Lite-Scheinwerfer . Dayline-Scheinwerfer
Katzensitter Says:
I used piwik before but was not satisfied. Now I want to give it a try again at my catsitting Website http://www.katzenbetreuung.net/ :)
Xenon Says:
Ein schöner Shop für supertolles Xenon…..
Gestörter Says:
Großartig und auf der sicheren Seite. Macht weiter so
dwinger Says:
Sehr hilfreiches Teil – dafür aller-herzlichsten Dank …!
Yoga Says:
Habe das Programm ausprobieren können, erster Eindruck war echt gut.
Ulli Knecht Says:
Auch wir setzen nun das Programm ein und sind begeistert! Bitte weiter entwickeln!
Hermann Strecker Says:
Also bisher habe ich mit analytics immer gute Erfahrungen gemacht. Aber bei dem feedback will ich auch mal PIWIK testen… Danke für die Arbeit!
Kevin Says:
Super Arbeit,weiter so! PIWK RULEZ!
Anja Golf Says:
Code von der Seite gelöscht und nun mit Piwik unterwegs!
Printerwelt Says:
Ich bin froh von Analytics zu piwik gewechselt zu sein!
Weiter so!
Javarapper Says:
Danke!!!….PIWIK ist klasse!!! Supi
lisa Says:
Well done, amazing work!
backlinks Says:
I had no idea you could do this with the iphone/ipad! Javascript has come along way. Or should I say, Apple has come a long way.
Schraubertv Says:
Ich traue Analytics nicht so wirklich, ergo – super Alternative!
Carsten Says:
Sehr gute Alternative zu Tante G`s Analytics. Habe ich auf diversen Seiten im Einsatz und kann nichts negatives berichten!
Svenja Leidtholt Says:
Wir werden das ganze auch mal testen, haben mehrere Seiten und da lohnt sich etwas komplexes schon….
Danke für die tolle Arbeit!
Simone Deidel Says:
Also nach Analyitcs und Woopra nutze ich Piwik – und ich liebe es. Vor allem die stetigen Weiter-Entwicklungen finde ich Klasse, da merkt man, dass es voran geht!
Shop Sopy Says:
Wir nutzen auch Piwik. Kann nur sagen einfach Spitze. Danke an Piwik.
Richter Maik Says:
Danke für das gute Tool. Wir werden Sie mit sicherheit Treu bleiben.
prepaid Says:
Früher war ich mit zufrieden. Werde die neue Version eimal testen und hier berichten
Lifestyle Men Says:
Danke für das tolle Programm, hab’s im Einsatz, dass ist eine schöne Erleichterung. Weiter so!
Karsten Says:
Danke für Piwik, wenn ich es jetzt noch schaffen würde eine Cronjob bei All-inkl hinzukriegen wäre ich glücklich. :-)))
Portable Software Says:
Super Programm. Gruß!
Stefan Says:
Ihr werdet mit der Zeit immer besser. Jedenfalls seid Ihr aktuell die einzig denkbare Alternative für Google Analytics. Nur weiter so!
paul-sims Says:
hat wohl kein admin cookie und trackt den admin mit hab ich gelesen.
sprüche Says:
awesome work! only the iphone app got still some bugs…
Thumbs up!
G. Analytics is the past ;-)
sprüche Says:
awesome work! only the iphone app got still some bugs…
Thumbs up!
G. Analytics is the past ;-)
sport components Says:
Endlich ein Programm, mit dem man gerne arbeitet.
Baffy Scorpion Says:
Ich hatte Piwik einmal in einer älteren Version genutzt und war nicht sonderlich zufrieden. Die neuen Features hören sich aber interessant an. Ich werde auf meiner Entertainer Seite noch einmal Piwik ausprobieren und werde Euch dann über mein Fazit berichten.
Gewinnspiele Says:
Ich liebe Piwik!
Galerie Says:
Da kann Google aber bald einpacken :)
Kunst Says:
Super….PIWIK ist klasse!!! DANKE!!!
Hundefutter Says:
Dank der tollen Software brauchen wir jetzt kein Analytics mehr :)
Dirk Says:
Schon wieder eine neue Version. Irgendwie komme ich mit dem Updaten nicht mehr nach. :-))
Aber dank Piwik bin ich Analytics endlich los…
dauerhafte Haarentfernung Says:
Mit Piwik haben wir den Überblick! Gratulation zu den neuen Funktionen-Danke!
bal-kes Says:
Piwik ist schon was besonderes in sachen Ranking
Jazz Radio Says:
Piwik entwickelt sich immer mehr zur Analytics-Alternative – Danke!
jaffimail Says:
check my hp. it free mailer with more feteures “
smartpack Says:
mensch das ist super hier. das nennt man aufschwung!
Laleoglu Says:
Didn’t hear of qUnit for testing, will try to learn more about it – testing is so much important, I am using phpUnit so far and it helps me so much every new day.
Freundschaftsringe Says:
Tolle Software. Danke an alle.
Bianca Says:
Piwik ist genial!Danke dafür!
Link building|seo Says:
Is there any Updates for this?
Hans Says:
Danke für die neue Funktion
Schulze Says:
Piwik looks great to me. We will give it a try.
Tarif Vergleichen Says:
Tarife zu vergleichen bringt sehr viele Vorteile mit sich. Ein Tarifvergleich kann Ihnen bares Geld einsparen, dass Sie dann für andere schöne Dinge zur Verfügung haben. Ein Tarifvergleich gibt es beispielsweise für Stromanbieter, DSL Provider, Versicherungen, Urlaubsbuchungen und Gasanbietern. Mit unserem umfassenden Angebot an Tarifvergleichen, helfen wir Ihnen dabei schnell und einfach die besten Tarife herauszufinden, dass ganze ohne viel Aufwand!
pandora Says:
We heard your complaints. We read your suggestions. We tackled your support requests. And after many code reviews and test cycles, we believe it’s time to unleash the code.
Wellness-Galaxy Says:
Ich utze auch nur noch Piwik, gute Arbeit!
DAYLINE Says:
headlights, led-lights, daytimerunning-lamps DAYLINE
joomla suchmaschinenoptimiert Says:
Ich werde es bei meinen webseite die ich mit joomla erstelle mal testen.
Trauringe 585 Says:
Ich habe Piwik noch nicht benutz aber werde es mal testen.
Horst Says:
Ich nutze schon lange Piwik, danke & weiter so an die developer!
ascii Says:
Great ap! Great work!
Sara's Handmade Jewelry Blog Says:
Great API. I’m loving the new Pivik Javascript. Great work guys!
Hier Says:
Piwik Api is much much better than Analytics. I use your Tool every day with my 7 websites. Best regards Uwe
Chris Whisky-Lova Says:
Didn’t hear of qUnit for testing, will try to learn more about it – testing is so much important, I am using phpUnit so far and it helps me so much every new day.
the wet something Says:
I think Piwik sounds even better than the “Big 3″. I think it is because you used the bug reports, suggestions and input that everyone submitted. Listening to the users is what will make Piwik number 1.
Rohrreinigung Says:
Multiple trackers on the same web page is now possible. And with the exception of legacy support, the code lives entirely in the Piwik namespace.
fairy in the gift Says:
I was searching for this kind of tool. It is very interesting to know that piwik is object oriented and supports xhtml.
Nextpress.net Says:
Piwik is amazing. I’m using it for all of my sites.
Paul Says:
Super, danke für dieses Tool :)
praca magisterska Says:
great, really!
Thomas Says:
Hi, I really enjoy your tool. This new feature will boost your popularity.
Great Job!
youngblogger Says:
i m agrreed with it…………………………….,.,.,
Gutscheinsammler Says:
Great job! thnx.
splintered eye Says:
Multiple trackers on the same web page is now possible. And with the exception of legacy support, the code lives entirely in the Piwik namespace.
splintered eye Says:
Top 18 Songs
Creavitargo Says:
Ja auch wir von Creavitorgo probierten Piwik mit erfolg aus. Macht weiter so und geht bitte weiter nach vorne.
Tribulus für dich Says:
Tribulus für dich probiertesdiese version gerne aus und hat auch mit anderen piwik anhänger über das thema gesprochen.
Maik Says:
auf so ein Tool habe ich lange gewartet, gut dass es euch mit solchen grossartigen ideen gibt, dankeschön.
unche Says:
Multiple trackers on the same web page is now possible. And with the exception of legacy support, the code lives entirely in the Piwik namespace.
Dosenwelten Says:
Hersteller von Blechdosen und Metallverpackungen
Viel Erfolg mit Ihrem Projekt
amit Says:
Top 10 Songs
amit Says:
Weiterhin viel Erfolg und hoffentlich eine Fortführung des Projekts.
Top 10 Songs
Fitiness Trainer San Diego Says:
I’m going to have to implement this on my site!
Akkuladegerät SONY Says:
super tool
Akku Nokia Says:
exelent works.congrat
Akkuladegerät CANON Says:
Hervoragende Arbeit. Danke!
Tortenaufleger Says:
Auch für mich ist einiges nützliches daraus abzugewinnen.
Forstseilwinden Says:
Solche Open Source Arbeiten ermöglichen vielen Menschen davon zu profitieren. Danke dafür
Coachingausbildung Says:
wünsche dem Piwik Projekt einen guten Erfolg und weitere tolle Ideen.
Günter Hogrefe Says:
Ein sehr gutes Programm, danke und Gruß
Günter
Kraftsport Deutschland Says:
Tolles Programm für Unsere Kraftsport Seite. Beste Grüße aus Berlin vom Kraftsport Deutschland Team.
Berlin Detektiv Says:
Sehr schönes Programm. Wir freuen und auf Erweiterungen. mfG Der Berlin Detektiv.
Ferienwohnung Usedom Says:
Auf dieses Tool haben wir gewartet. Viele Grüsse von der Ferienwohnung Usedom
Grappa Berta Says:
Great Work!
Kostenlos Werben Says:
GREAT, danke
Bündnis für Freiheit und Demokratie Says:
Ich wünsche euch viel erfolg!
Grappa Says:
Very Good!
Geistiges Heilen Says:
Danke für die tollen Kommentare. Wünsche weiterhin guten Erfolg.
Grüße Geistiges Heilen
Heilerschule Says:
Vielen Dank für die wertvollen Informationen.
Greetings Heilerschule
Anhaengerkupplungen Says:
Das ist ein sehr gutes projekt.
Anhängerkupplungen Says:
O mann sovile komentare . na ja ich wünsche euch viel erfolg.
Rummy City Says:
More improvements sounds great to me.
kredite Says:
Gott sei Dank gibt es solche Projekte noch in Zeiten von Kommerzialisierung und Gewinnstreben…
Miguel Says:
Piwik ist genial!
Danke dafür!
Rigo Says:
Sehr hilfreich, vielen Dank!
PDA batteria Says:
Fantastico
Handy Akku Says:
Perfect
Momo Says:
I am suprised and happy with this tool.
Suchmaschinenoptimierung Says:
Very Great tool this piwik Tracking API.
SEO Marketing Says:
Read more about that in livejournal – a fantastic blog.
JAV Says:
Noch mal ich. Bitte auch in den Newsletterversand aufnehmen…, danke.
Diabetes and Asthma Says:
Please inform me for the updates.
Lilienthal Says:
Weiterhin viel Erfolg in Ihrer Firma…
Schwarzwald Tourismus Says:
I am not sure that I understand the tool. Can anybody help me?
Kosmetikstudio Bremen Says:
Selbst ein “Kleinbetrieb” wie wir nutzen Piwik. Geht wirklich leicht.
Seminare Bremen Says:
Die Software arbeitet super. Wir haben viele Vorteile durch den Einsatz.
Betriebsrat Says:
Vielen Dank für die viele Arbeit. Grüße aus Münster
Betriebsrat Says:
Auf so ein Tool haben wir gewartet. Gut dass es Menschen mit Ideen gibt.
Kosmetik FM Says:
This is a really great Tool … :-)
Vergleich Says:
great work
Momo Says:
Freue mich über weitere etwiklung. Danke.
Uwe Says:
Hallo,
So macht es spass. Weiter so.
Milan Rajcic Says:
Exelent.
Milan Rajcic Says:
Hervoragende Arbeit. Weiter so. Danke.
trailerbike Says:
wir sind super zufrieden mit der Entwicklung, danke!
briggs Motor Says:
interessante Alternative zu anderen Tools. Bin mal gespannt wie es sich in der Praxis bewährt.
Autoankauf in Köln Says:
Super Sache !
Smart-Repair Köln Einfachschlauer Says:
Diese Entwicklung ist bereits ein großer Schritt
Lack-Beulen-Doktor Says:
Piwik ! weiter so !
Chihuahua Welpen Says:
Kompliment an Piwik
Beulendoktor Lackdoktor Köln Says:
Kann ich nur weiterempfehlen.
Webdesign Bergheim Says:
Piwik ist eine Sache die wir nie wieder missen wollen.
Autoankauf Köln Bergheim Says:
Ich Liebe Piwik !!!
Immobilienmakler Bick Says:
Piwik ist das beste was ich je gesehen habe.
Spot Smart Repair Says:
echt toll !!
Andreas Says:
Kompliment über die schnelle Entwicklung!
Claudia Damrich cdvet Says:
Diese Entwicklung ist sehr Interessant und ich finde das der Piwik’s JavaScript Tracker eine echte Alternative ist. Grüße von Claudia
Milan Rajcic Says:
Danke.
Graziano Gallicchio Says:
Hervorragende Arbeit bisher. Ich hoffe das ein solch gutes Projekt von Dauer ist und sich noch weiterentwickelt.
Viele Grüße aus Deutschland
Graziano Gallicchio
Klaus Uebbing Says:
Coole Produkte
Uwe Schwarz Says:
Diese Entwicklung ist bereits ein großer Schritt in die richtige Richtung. Dennoch bin ich gespannt wie es mit Piwik’s weitergeht.
Grüße
Uwe Schwarz
Webdesign Says:
Ich bin Ihnen für die Informationen sehr dankbar
Preisvergleich Says:
piwik is very great. it was recommended to me by my best friend!
Feuerwehr Spiele Says:
hi, realy great work, very helpfull for me, greetings from ilmenau in Germany.
garlando Says:
Great tool this piwik Tracking API
Catta Says:
Danke Piwik,habe es eben runtergeladen und installiert
japanische Kochmesser Says:
Visually appealing graphics, modular architecture, and high performance – I recommend piwik
Gelbeschaffung "NEU" Says:
google trends is out, we have checked out piwik!
Sanek Says:
Убежден, дурная новость
autismus Says:
we are using piwik too, that much better than tracking software from G…le
Green Tea Weight Loss Says:
One word : Awesome. I have actually written a Custom plugin for my own website (following the Live API example) and made some changes to the Visit.php class as I wanted to track custom user information. Just wanted to say you guys rock big time :)
Azoren Fan Says:
affengeil ist eine untertreibung!
Tobias Says:
affengeile software!
Angela Says:
Splendido!
Motercalo Says:
Great job guys, excellent !
sneakersblog Says:
super software bin begeistert
Jens Says:
Vielen Dank für eure Mühe. LG aus dem Emsland, Jens
Peter Kaiser Says:
Vielen Dank für die Sotware. Grüsse von Peter Kaiser
rollstuhl Says:
habe es gerade gesehen werde es gleich testen
plattformlift Says:
Danke Piwik,
habe es sofort runtergelagen.
hebebühne Says:
danke für das program hatt mir sehr geholfen.
Günter Hogrefe Says:
Ich bin Ihnen für die Informationen sehr dankbar und grüße Sie aus Ostfriesland
Günter
Ghostwriting Says:
I’ts a Great work!!
jimmy Says:
Lets do
Google.com
Sportishqiptar Says:
danke sehr
Ferienwohnungen Cuxhaven Says:
I am totally happy with piwik.
It can helps me to save a lot of time for analysing my customer for Ferienwohnungen in Cuxhaven Duhnen.
Australien Fan Says:
Great work!!
Partyshqip Says:
danke danke
Trompeter Says:
Naja jeder kennt ja bestimmt einen der ein bisschen programmieren kann, man hilft sich eben gegenseitig aus oder nicht? Der eine kann dies dafür der andere das, aber Piwik ist trotzdem klasse auch mit wenigen Programmier Kentnissen.
Piwik Rockt
Rechnung online schreiben Says:
Die neue API Schnittstelle ist wieder einmal eine hervorragende Sache. Leider braucht man dafür programmierkenntnisse so dass ich da an meine Grenzen stosse. Aber ich steh trotzdem voll auf Piwik.
Riester Says:
very good work – i will use it on my site
Riester Rente Says:
good work – very helpfull for my site
YaaCool-Bio Says:
I´m of same opinion. Great work!
Dauerhafte Haarentfernung Says:
I will use it on my site about “dauerhafte Haarentfernung mit Laser” from now on!!!
Rechnungen online schreiben Says:
Just checking it out – wonderful software.
Br,
Andreas
Rechnungen online schreiben Says:
I really needed an alternative to Google Analytics for my new projects – I am testing it right now and hope I have found what I’ve been looking for…
Br,
Andreas
Truckkas Says:
Ja Bless
Enthaarung Says:
Piwik is a perfect tool for the webanalysis!
Gojiji Says:
Piwik just made my day! Hooray!
Personalisierte Kinderbücher Says:
Wow, thats really great. You guys rules!
Maxim Says:
Piwik rocks!
is zekasi Says:
Good job. I’m looking forward to the new release.
Marcus Buckingham Says:
This Api requires engineering craft. Great job.
Limited Sirket Says:
statcounter also use piwik as its primary infrastructure and it is good choice.
Haarentfernung Says:
Die Entwicklung von Piwik ist hervorragend. Seid ich Piwik nutze habe ich endlich den Durchblick wie ich ihn brauche.
Danke.
news Says:
the new api runs well, but the database is getting biger and biger. how will you fix this in the future?!
lanyards Says:
you surprise me everytime with new scripts.
piwik make the world better
all wishes for future works
lanyards
kuriozite Says:
this java scrip was so cool it solved all the ideas i head…
trauringe Says:
hi, what a great work, very helpfull for my, greetings from Germany
exodus Says:
Awesome api!
Michael Says:
Well done, amazing work!
thE_iNviNcbilE Says:
wow… all stuff sounds great :-)
Poyan Says:
Great job guys, excellent!
Hans-Peter Says:
congratulations! great work.
Silvan T. Golega Says:
“Specifically, the calls to document.write() [...] are history.”
Yippie!
SEO Guru Says:
Holy Dooly now this is going to be some fun too play with.
mmmmm the possibilities.
Stephan Says:
How do I catch non JS-Visitors? Are they not relevant anymore?