Skip to main content
This walks through going from nothing to a working dashboard: deploy Klaritics, instrument an app, send an event, and build something from it.
You need two values throughout: a project_id identifying your project, and a server_host pointing at your deployment. Both come from your Klaritics instance once it is running.

​
1. Deploy Klaritics

Klaritics runs inside your own infrastructure. Follow the self-hosted deployment guide to stand up your environment. You finish this step with a project_id and a server_host URL.

​
2. Install an SDK

Pick the platform you want to instrument. Every SDK follows the same pattern, so the concepts carry across.

Web

Android

iOS

React Native

Flutter

Kotlin Multiplatform

​
3. Initialize and send an event

Name events for what happened in your product — add_to_cart, ProductClicked — and keep the naming consistent from the start. See Event naming; the $ prefix is reserved.

​
4. Confirm the event arrived

Open Real-Time Events and look for your event. It shows the incoming event stream along with the properties attached to each one, so you can verify the payload is what you expected before building anything on top of it. If nothing appears, check that server_host is reachable from the client and that project_id matches your project.

​
5. Turn it into something useful

1

Build an analysis

Create a Chart Analysis from your event, or jump straight to a Funnel if you have two or more steps to measure. Saving the analysis produces a chart.
2

Pin it

Pin the chart to the project Overview, an existing dashboard, or a new one.
3

Share it

Set the dashboard to Restricted or Project-wide so your team can see it. See Sharing.
4

Set an alert

Configure alerts on the chart so changes reach you without checking.
In a hurry? Skip the manual build and apply a template. Pick Product KPIs, supply one active event, and you have a populated dashboard immediately.

​
Where to go next

Organize your events

Name, categorize, and control visibility in Event Taxonomy.

Product Analytics

Four configurable dashboards covering health, onboarding, engagement, and retention.

Invite your team

Add teammates and assign roles.

Explore the SDKs

Full integration guides for every platform.