Skip to content

kriserickson/cordova-piwik-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Piwik Analytics Plugin

Native Piwik Analytics based upon the Piwik SDK for Android and PiwikTracker iOS SDK.

  • This plugin is built for Cordova >= v3.3.0..

Supported Platforms

  • Android
  • iOS Half Working, YMMV

Installation

Piwik Analytics Plugin is compatible with Cordova Plugman, compatible with PhoneGap 3++ CLI.

$ cordova plugin add https://github.com/kriserickson/cordova-piwik-plugin

To get the IOS version to work you have to drag the piwiktracker.xcdatamodeld package from the plugins/com.storefront.cordova/piwik/src/ios directory into XCode into the plugins directory (when cordova commandline adds the ability to add a folder reference, this will be removed (https://issues.apache.org/jira/browse/CB-8177).

Note: The iOS version does not yet suppport tracking goals and custom variables...

Usage

Before you do anything you must initialize the tracker with startTracker. The trackerUrl is the url of your piwik tracker (see how to track Mobile apps usage for more information on setting up Piwik as a mobile app tracker), and the applicationId is the applicationId you have created for your tracker.
Passing a userId is optional, and should respect the users privacy and any platform limitations about passing around things like the device.uuid.

piwik.startTracker(trackerUrl, applicationId, [userId], [success], [error]);

Tracking a screen takes a required path, and an optional title.

piwk.trackScreenView(path, [title], [success], [error]);

Tracking an exception is done by passing the class the exception occurred in, as well a description. You can optionally state whether it was a fatal error (boolean).

piwik.trackException(class, description, [isFatal], [success], [error]);

Tracking an event requires a category and an action, the label and value are both optional.

piwik.trackEvent(category, action, [label], [value], [success], [error]);

Tracking a goal takes requires a goalId (which is an integer and must be set up from your Piwik Administrator Panel). Revenue associated with said goal is optional.

piwik.trackGoal(idGoal, [revenue], [success], [error]);

You can set customVariables by screen and by user. Index is an integer between 1 and 5 (by default Piwik currently limits 5 variables per site however this can be be changed in the configuration). name and value are strings but must be shorter than 200 characters. For more information see Custom Variable Analytics in the Piwik documentation.

piwik.setScreenCustomVariable(index, name, value, [success], [error]) {
piwik.setUserCustomVariable = function(index, name, value, success, error) {

About

Piwik Plugin for Apache Cordova

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published