iOS SDK Integration Guide for Klaritics

The Klaritics iOS SDK collects analytics from iOS apps and sends them to your self-hosted Klaritics instance. Add it with Swift Package Manager, then initialize it once from your app delegate. Package: github.com/deeptaai/klaritics-ios-sdk · Version: 1.0.0

Requirements

Requirement	Value
Package manager	Swift Package Manager
Languages	Swift, Objective-C

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

Add the package

Open Add Package Dependencies

In Xcode, choose File → Add Package Dependencies.

Add the Klaritics repository

Paste the repository URL:

github.com/deeptaai/klaritics-ios-sdk

Add the library to your target

In Choose Package Products, select the Klaritics library, choose your app target under Add to Target, and click Add Package.

Xcode resolves and downloads the dependency in the background.

Initialize the SDK

Import Klaritics and call Klaritics.setup(config) once, in application(_:didFinishLaunchingWithOptions:), before any other Klaritics call.

AppDelegate.swift

import Klaritics

@UIApplicationMain
class AppDelegate: NSObject {

    func application(_ application: UIApplication,
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        let config = KlariticsConfig(appId: "YOUR_PROJECT_ID", host: "https://YOUR_SERVER_HOST")
        Klaritics.setup(config)

        return true
    }
}

`KlariticsConfig`

Property	Type	Default	Description
`appId`	`String`	— (required)	Your `project_id` from the Klaritics dashboard (Getting Started page).
`host`	`String`	— (required)	Server URL to send data to.

The SDK does not initialize until both appId and host are provided.

API reference

All methods are called on Klaritics. Attributes are [String: Any] dictionaries.

Method	Swift	Objective-C
`setup`	`setup(_ config: KlariticsConfig)`	`setup:`
`logAppEvent`	`logAppEvent(withName:info:)`	`logAppEventForEvent:withInfo:`
`setUserIdentifier`	`setUserIdentifier(_:)`	`setUserIdentifier:`
`setUserCustomInfo`	`setUserCustomInfo(_:)`	`setUserCustomInfo:`
`setSessionCustomInfo`	`setSessionCustomInfo(_:)`	`setSessionCustomInfo:`
`trackScreen`	`trackScreen(_:)`	`trackScreen:`
`getDeviceId`	`getDeviceId() -> String?`	`getDeviceId`

Common recipes

Log an event

Klaritics.logAppEvent(withName: "button_clicked", info: ["button_label": "Submit"])

[Klaritics logAppEventForEvent:@"button_clicked" withInfo:@{ @"button_label": @"Submit" }];

Identify a user and set properties

Klaritics.setUserIdentifier("user_123")

Klaritics.setUserCustomInfo(["email": "user@example.com", "plan": "pro"])

// Session-scoped properties
Klaritics.setSessionCustomInfo(["network": "4G"])

let deviceId = Klaritics.getDeviceId()

Track a screen

Klaritics.trackScreen("home")

Troubleshooting

Symptom	Fix
Nothing is sent	Check that both `appId` and `host` are set in `KlariticsConfig`. The SDK doesn’t initialize without both.
`No such module 'Klaritics'`	The Klaritics library wasn’t added to your app target. Re-check the last step of Add the package.

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

Package: github.com/deeptaai/klaritics-ios-sdk · Version: 1.0.0 · Release notes

Get Started

Cohorts

Product Analytics

Data

Behavior Analytics

Charts

Default Templates

Saved Charts

Saved Dashboards

Settings

Integrations

Deployment

Reference

iOS SDK Integration Guide for Klaritics

Requirements

Add the package

Initialize the SDK

`KlariticsConfig`

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 package

​Initialize the SDK

​KlariticsConfig

​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 package

Initialize the SDK

`KlariticsConfig`

API reference

Common recipes

Log an event

Identify a user and set properties

Track a screen

Troubleshooting

Next steps