README.md

Matomo SDK for Android

Welcome to the Matomo Tracking SDK for Android. This library helps you send analytics data from Android apps to Matomo instances. Until v4 this library was known as Piwik Tracking SDK for Android.

Features:

• Caching and offline support
• Graceful reconnection handling
• WIFI-only mode
• Thread-safe support for multiple trackers
• Support for custom connection implementations
• Complete Matomo HTTP API support
  • Custom dimensions
  • Event Tracking
  • Content Tracking
  • Ecommerce
• Checksum based app install/upgrade tracking

Quickstart

For the not so quick start, see here or look at our demo app

• Setup Matomo on your server.
• Include the library in your app modules build.gradle file

    implementation 'org.matomo.sdk:tracker:<latest-version>'

• Initialize your Tracker either by extending our MatomoApplication class or storing an instance yourself:

public class YourApplication extends Application {
    private Tracker tracker;
    public synchronized Tracker getTracker() {
        if (tracker == null) tracker = Matomo.getInstance(this).newTracker(new TrackerConfig("http://domain.tld/matomo.php", 1));
        return tracker;
    }
}

• The TrackHelper class is the easiest way to submit events to your tracker:

// Get the `Tracker` you want to use
Tracker tracker = ((MatomoApplication) getApplication()).getTracker();
// Track a screen view
TrackHelper.track().screen("/activity_main/activity_settings").title("Settings").with(tracker);
// Monitor your app installs
TrackHelper.track().download().with(tracker);

License

Android SDK for Matomo is released under the BSD-3 Clause license, see LICENSE.