Flutter SDK Integration Guide for Klaritics

The Klaritics Flutter SDK is a Dart wrapper around the native Klaritics Android and iOS SDKs. A single call from Dart initializes both platforms, so you add no setup code to your Activity, Application, or AppDelegate. Package: klaritics_flutter · Version: 1.0.0

Requirements

Requirement	Value
Flutter	`>= 3.0.1`
iOS dependency manager	Swift Package Manager (Flutter’s SwiftPM support enabled)

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

Add the dependency

pubspec.yaml

dependencies:
  klaritics_flutter: ^1.0.0

import 'package:klaritics_flutter/klaritics_flutter.dart';

Initialize the SDK

Initialize once, from main() before runApp, and await the call before logging any events:

main.dart

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  final config = KlariticsConfig('YOUR_PROJECT_ID');
  config.host = 'https://YOUR_SERVER_HOST';
  await KlariticsFlutter.setup(config);

  runApp(const MyApp());
}

`KlariticsConfig`

Property	Type	Description
(constructor argument)	`String`	Required. Your `project_id` from the Klaritics dashboard.
`host`	`String`	Required. Server URL to send data to.

Because initialization happens from Dart, don’t call the native Klaritics.setup(...) in your Android Activity or Application, or in your iOS AppDelegate.

Android setup

Add the Klaritics Maven repository

Add it to the repositories block in android/build.gradle (or settings.gradle):

android/build.gradle

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

Add the native SDK dependency

app/build.gradle

dependencies {
    implementation "com.deeptaai.klaritics:klaritics-android-sdk:1.0.0"
}

Configure ProGuard

If you use ProGuard, add to proguard-rules.pro:

proguard-rules.pro

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

iOS setup

The plugin declares the native Klaritics iOS SDK in its Package.swift. With Flutter’s Swift Package Manager support enabled, it’s added to your iOS app automatically. No AppDelegate changes are required.

API reference

All methods are called on KlariticsFlutter. Attributes are Map<String, dynamic>.

Method	Signature	Description
`setup`	`Future<void> setup(KlariticsConfig config)`	Initialize both platforms. Call once, before anything else.
`logAppEvent`	`logAppEvent(String eventName, {Map<String, dynamic>? attributes})`	Log an analytics event.
`setUserIdentifier`	`setUserIdentifier(String userIdentifier)`	Attach your own identifier to the current user.
`setUserAttributes`	`setUserAttributes(Map<String, dynamic> attributes)`	Set user-level properties.
`setSessionAttributes`	`setSessionAttributes(Map<String, dynamic> attributes)`	Set properties scoped to the current session.
`trackScreen`	`trackScreen(String screenName)`	Record a screen view.
`getDeviceId`	`Future<String?> getDeviceId()`	Return the SDK-generated device identifier.

Common recipes

Log an event

KlariticsFlutter.logAppEvent("login", attributes: {
  "type": "google",
  "language": "en",
});

Identify a user and set attributes

The SDK captures a device ID automatically. Add your own identifier when you want to follow a specific user’s journey:

KlariticsFlutter.setUserIdentifier("user_123");

KlariticsFlutter.setUserAttributes({
  'age': 27,
  'plan': 'pro',
});

// A session runs from opening the app to closing it
KlariticsFlutter.setSessionAttributes({
  "network": "4G",
  "location": "Hyderabad",
});

final deviceId = await KlariticsFlutter.getDeviceId();

Track a screen

KlariticsFlutter.trackScreen("home");

Troubleshooting

Symptom	Fix
Events logged before setup are missing	`await KlariticsFlutter.setup(config)` in `main()` before `runApp`.
Android build can’t resolve `klaritics-android-sdk`	Add the Maven repository. See Android setup.
iOS doesn’t pick up the native SDK	Enable Flutter’s Swift Package Manager support.

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 Flutter SDK version.

Package: klaritics_flutter · Version: 1.0.0 · Flutter: 3.0.1+ · Release notes

Get Started

Cohorts

Product Analytics

Data

Behavior Analytics

Charts

Default Templates

Saved Charts

Saved Dashboards

Settings

Integrations

Deployment

Reference

Flutter SDK Integration Guide for Klaritics

Requirements

Add the dependency

Initialize the SDK

`KlariticsConfig`

Android setup

iOS setup

API reference

Common recipes

Log an event

Identify a user and set attributes

Track a screen

Troubleshooting

Next steps

Verify your integration

Release notes

​Requirements

​Add the dependency

​Initialize the SDK

​KlariticsConfig

​Android setup

​iOS setup

​API reference

​Common recipes

​Log an event

​Identify a user and set attributes

​Track a screen

​Troubleshooting

​Next steps

Verify your integration

Release notes

Requirements

Add the dependency

Initialize the SDK

`KlariticsConfig`

Android setup

iOS setup

API reference

Common recipes

Log an event

Identify a user and set attributes

Track a screen

Troubleshooting

Next steps