SDK for Android to measure your apps with Piwik
Branch: master
Clone or download

README.md

Matomo SDK for Android

Download Build Codecov

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:

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:
import org.matomo.sdk.TrackerBuilder;

public class YourApplication extends Application {
    private Tracker tracker;
    public synchronized Tracker getTracker() {
        if (tracker == null) tracker = TrackerBuilder.createDefault("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.