Integrate the Klaritics Android SDK in Your App

The Klaritics Android SDK collects analytics from Android applications and sends them to your self-hosted Klaritics instance. This guide covers Gradle setup, initialization, event logging, and user identification.

Installation

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

implementation("com.deeptaai.klaritics:klaritics-android-sdk:x.x.x")

Replace x.x.x with the latest version number.

Initialization

Initialize the SDK in your Application class or main entry point before logging any events:

Klaritics.initialize(
    appId = "YOUR_APP_ID",
    serverHost = "https://YOUR_SERVER_HOST"
)

The SDK will not initialize until both appId and serverHost are provided.

Logging events

Use logAppEvent for standard analytics events and logClientEvent for client-specific events.

val additionalInfo = mapOf(
    "product_id" to "sku-123",
    "category" to "electronics"
)
Klaritics.logAppEvent("ProductClicked", additionalInfo)

val clientInfo = mapOf(
    "source" to "soft_back"
)
Klaritics.logClientEvent("SoftBackPressed", clientInfo)

User identification

Link events to a known user with setUserIdentifier:

Klaritics.setUserIdentifier("user@example.com")

Retrieve the SDK-generated device identifier:

val deviceId = Klaritics.getDeviceId(applicationContext)

Important naming note

The client-facing class is Klaritics. Do not use KlariticsSDK, KlariticsCore, or any other variant in your application code.

⌘I

Get Started

User Management

Analysis

Dashboards

Widgets

Data

Templates

Alerts & Integrations

SDK Integration

Deployment

Reference

Integrate the Klaritics Android SDK in Your App

Installation

Initialization

Logging events

User identification

Important naming note

​Installation

​Initialization

​Logging events

​User identification

​Important naming note

Installation

Initialization

Logging events

User identification

Important naming note