Repository files navigation

Welcome to theMatomo Tracking SDK for Android. This library helps you send analytics data from Android apps to Matomo instances. Until v4 this library was known asPiwik 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
• CompleteMatomo HTTP API support
  • Custom dimensions
  • Event Tracking
  • Content Tracking
  • Ecommerce
• Checksum based app install/upgrade tracking

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

• Setup Matomo on your server.
• Include the library in your app modulesbuild.gradle fileviaJitPack

repositories {  maven { url'https://jitpack.io' }}dependencies {  implementation'com.github.matomo-org:matomo-sdk-android:<latest-version>'}

• Now you need to initialize yourTracker. It's recommended to store it as singleton. You can extendMatomoApplication or create and store aTracker instance yourself:

importorg.matomo.sdk.TrackerBuilder;publicclassYourApplicationextendsApplication {privateTrackertracker;publicsynchronizedTrackergetTracker() {if (tracker ==null){tracker =TrackerBuilder.createDefault("http://domain.tld/matomo.php",1).build(Matomo.getInstance(this));        }returntracker;    }}

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

// The `Tracker` instance from the previous stepTrackertracker = ((MatomoApplication)getApplication()).getTracker();// Track a screen viewTrackHelper.track().screen("/activity_main/activity_settings").title("Settings").with(tracker);// Monitor your app installsTrackHelper.track().download().with(tracker);

• Something not working? Checkhere.

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