Android SDK Integration Guide for Klaritics

The Klaritics Android SDK collects analytics from Android apps and sends them to your self-hosted Klaritics instance. Add the Maven repository and dependency, then initialize once from your Application. Artifact: com.deeptaai.klaritics:klaritics-android-sdk:1.0.2

Requirements

You need a Project ID and a Server host from the Klaritics dashboard. Your project ID is on the Getting Started page.

Add the repository

The SDK is published to a public Maven repository. Add it in whichever place your project declares repositories:

allprojects {
    repositories {
        // ...
        maven { url "https://asia-south1-maven.pkg.dev/org-infra-471907/klaritics-android-sdk" }
    }
}

dependencyResolutionManagement {
    repositories {
        // ...
        maven { url "https://asia-south1-maven.pkg.dev/org-infra-471907/klaritics-android-sdk" }
    }
}

If your project uses dependencyResolutionManagement with RepositoriesMode.FAIL_ON_PROJECT_REPOS, the repository must go in settings.gradle.

Add the dependency

app/build.gradle

dependencies {
    implementation 'com.deeptaai.klaritics:klaritics-android-sdk:1.0.2'
}

Configure your build

Keep Klaritics classes in ProGuard / R8

If you use ProGuard or R8, keep the Klaritics classes so events are logged correctly:

proguard-rules.pro

-keep class com.deeptaai.** { *; }
-dontwarn com.deeptaai.**

Disable dexing artifact transformation

Add this flag to your app module’s gradle.properties, at <project>/<app-module>/gradle.properties:

gradle.properties

android.enableDexingArtifactTransform = false

Initialize the SDK

Call Klaritics.setup(context, config) once, from your Application class or main entry point, before any other Klaritics call.

val config = KlariticsConfig("YOUR_PROJECT_ID", "https://YOUR_SERVER_HOST")
Klaritics.setup(applicationContext, config)

KlariticsConfig config = new KlariticsConfig("YOUR_PROJECT_ID", "https://YOUR_SERVER_HOST");
Klaritics.setup(getApplicationContext(), config);

`KlariticsConfig`

Argument	Type	Description
1st	`String`	Your `project_id` from the Klaritics dashboard (Getting Started page).
2nd	`String`	Your server host — the URL of your Klaritics instance.

Verify initialization

When the SDK initializes successfully, this line appears in Logcat:

Klaritics(v2**) successfully initialized for: PROJECT_ID

API reference

All methods are called on the Klaritics object. Attributes are Map<String, Any?>.

Method	Signature	Description
`setup`	`(context: Context, config: KlariticsConfig)`	Initialize the SDK. Call once, before anything else.
`logAppEvent`	`(eventName: String, attributes: Map<String, Any?>? = null)`	Log an analytics event sent to Klaritics.
`setUserIdentifier`	`(userIdentifier: String)`	Attach your own identifier to the current user.
`setUserCustomInfo`	`(userCustomInfo: Map<String, Any?>)`	Set user-level properties.
`setSessionCustomInfo`	`(attributes: Map<String, Any?>)`	Set properties scoped to the current session.
`trackScreen`	`(screenName: String)`	Record a screen view.
`getDeviceId`	`(context: Context): String?`	Return the SDK-generated device identifier.

Common recipes

Log an event

Klaritics.logAppEvent("product_clicked", mapOf(
    "product_id" to "sku-123",
    "category" to "electronics",
))

Identify a user and set properties

Klaritics.setUserIdentifier("user_123")

Klaritics.setUserCustomInfo(mapOf(
    "email" to "user@example.com",
    "plan" to "pro",
))

// Session-scoped properties
Klaritics.setSessionCustomInfo(mapOf("network" to "4G"))

val deviceId = Klaritics.getDeviceId(applicationContext)

Track a screen

Klaritics.trackScreen("home")

Troubleshooting

Symptom	Fix
No `successfully initialized` line in Logcat	Check the Maven URL, the dependency version, and your project ID and server host values.
`klaritics-android-sdk` not found	The repository isn’t declared, or your project uses `FAIL_ON_PROJECT_REPOS` and it’s in `build.gradle` instead of `settings.gradle`. See Add the repository.
Events missing in release builds	The ProGuard / R8 keep rules are missing. See Configure your build.

Next steps

Verify your integration

Send test events from your app and watch them land on the Getting Started page.

Release notes

What changed in each Android SDK version.

Artifact: com.deeptaai.klaritics:klaritics-android-sdk:1.0.2 · Release notes

Get Started

Cohorts

Product Analytics

Data

Behavior Analytics

Charts

Default Templates

Saved Charts

Saved Dashboards

Settings

Integrations

Deployment

Reference

Android SDK Integration Guide for Klaritics

Requirements

Add the repository

Add the dependency

Configure your build

Initialize the SDK

`KlariticsConfig`

Verify initialization

API reference

Common recipes

Log an event

Identify a user and set properties

Track a screen

Troubleshooting

Next steps

Verify your integration

Release notes

​Requirements

​Add the repository

​Add the dependency

​Configure your build

​Initialize the SDK

​KlariticsConfig

​Verify initialization

​API reference

​Common recipes

​Log an event

​Identify a user and set properties

​Track a screen

​Troubleshooting

​Next steps

Verify your integration

Release notes

Requirements

Add the repository

Add the dependency

Configure your build

Initialize the SDK

`KlariticsConfig`

Verify initialization

API reference

Common recipes

Log an event

Identify a user and set properties

Track a screen

Troubleshooting

Next steps