Kotlin SDK for Aptabase

Instrument your apps with Aptabase, an Open Source, Privacy-First and, Simple Analytics for Mobile, Desktop and, Web Apps.

Setup

Add the JitPack repository in settings.gradle.kts file:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://www.jitpack.io") } // JitPack repository
    }
}

Add the dependency to your module-level build.gradle.kts file:

    implementation("com.github.aptabase:aptabase-kotlin:0.0.8")

If you don't already have an Application class, create one. Then, initialize the Aptabase object inside your application class:

private const val APTABASE_KEY = "YOUR_APP_KEY"
// Put the app key provided by Aptabase as the value of APTABASE_KEY
// It is a unique identifier for you application

class MyApplication : Application() {

   override fun onCreate() {
      super.onCreate()
      // Initialize Aptabase object
      Aptabase.instance.initialize(applicationContext, APTABASE_KEY)
      // OPTIONAL: Track app launch on startup
      Aptabase.instance.trackEvent("app_started")
   }

}

To get your App Key, you can find it inside Instructions tab from the left side menu of the Aptabase website.

Usage

You are in charge of what information is sent! Therefore, no events are tracked automatically and you must register trackers manually. To do so, simply use the trackEvent function provided by the Aptabase object:

// Event with no properties
Aptabase.instance.trackEvent("event_name")
// Event with a custom property
Aptabase.instance.trackEvent("screen_view",
   mapOf<String, Any>(
      "name" to "Settings" // Only <String> and <Int> values are allowed for custom properties
   )
)