Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matomo-org/matomo-sdk-android
SDK for Android to measure your apps with Matomo. Works on Android phones, tablets, Fire TV sticks, and more!
https://github.com/matomo-org/matomo-sdk-android
analytics android android-sdk java matomo matomo-sdk metrics piwik piwik-sdk tracker
Last synced: 3 months ago
JSON representation
SDK for Android to measure your apps with Matomo. Works on Android phones, tablets, Fire TV sticks, and more!
- Host: GitHub
- URL: https://github.com/matomo-org/matomo-sdk-android
- Owner: matomo-org
- License: bsd-3-clause
- Created: 2014-08-26T07:37:33.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T02:29:30.000Z (7 months ago)
- Last Synced: 2024-04-14T00:26:46.782Z (7 months ago)
- Topics: analytics, android, android-sdk, java, matomo, matomo-sdk, metrics, piwik, piwik-sdk, tracker
- Language: Java
- Homepage:
- Size: 5.69 MB
- Stars: 383
- Watchers: 46
- Forks: 161
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Matomo SDK for Android
========================
[](https://jitpack.io/#matomo-org/matomo-sdk-android)
[](https://codecov.io/gh/matomo-org/matomo-sdk-android?branch=master)
Welcome to the [Matomo](http://matomo.org) 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](https://developer.matomo.org/api-reference/tracking-api) support
* [Custom dimensions](https://matomo.org/docs/custom-dimensions/)
* [Event Tracking](https://matomo.org/docs/event-tracking/)
* [Content Tracking](https://matomo.org/docs/content-tracking/)
* [Ecommerce](https://matomo.org/docs/ecommerce-analytics/)
* Checksum based app install/upgrade tracking
## Quickstart
For the not so quick start, [see here](https://github.com/matomo-org/matomo-sdk-android/wiki/Getting-started) or look at our [demo app](https://github.com/matomo-org/matomo-sdk-android/tree/master/exampleapp)
* [Setup Matomo](https://matomo.org/docs/installation/) on your server.
* Include the library in your app modules `build.gradle` file
via [JitPack](https://jitpack.io/#matomo-org/matomo-sdk-android)
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.matomo-org:matomo-sdk-android:'
}
```
* Now you need to initialize your `Tracker`. It's recommended to store it as singleton. You can extend `MatomoApplication` or create and store a `Tracker` instance yourself:
```java
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).build(Matomo.getInstance(this));
}
return tracker;
}
}
```
* The `TrackHelper` class is the easiest way to submit events to your tracker:
```java
// The `Tracker` instance from the previous step
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);
```
* Something not working? Check [here](https://github.com/matomo-org/matomo-sdk-android/wiki/Troubleshooting).
## License
Android SDK for Matomo is released under the BSD-3 Clause license, see [LICENSE](https://github.com/matomo-org/matomo-sdk-android/blob/master/LICENSE).