Getting started

Hintway brings real-time analytics, custom dashboards, fast queries, and lightweight SDKs into your project, without juggling tools, waiting on stale data, or being locked into dashboards that miss your team’s questions.

This guide walks through the whole loop end to end: create a project, connect an SDK, track your first event, generate some data, and turn it into a dashboard widget you build with AI. It applies to any SDK: Unity, Unreal Engine, C#, Go, Rust, or the raw REST API.

---

1. Create a project

Everything starts in the Hintway dashboard.

1. Open the project dropdown and create a new project
2. Give it a name (for example, My First Project)
3. Once it’s created, choose the SDK that matches your stack

Keep this tab open; you’ll come back for your connection details in step 3.

---

2. Install the SDK

Each SDK installs a little differently, but the shape is always the same: grab the latest release, add it to your project, and let your build tooling pick it up. Follow the page for your platform:

Unity Add via git URL in the Package Manager.

Unreal Engine Drop the plugin into your project and rebuild.

C# / .NET WPF, MonoGame, Godot, Console, ASP.NET…

Go Lightweight library for backends and CLI tools.

Rust Thread-safe singleton for engines and desktop apps.

REST API No SDK for your platform? Send events over HTTP.

Note

SDK packages are published on GitHub under hintwayapp. Open the repo for your platform, go to Releases, and download the latest version.

Tip

No SDK for your platform? You don’t need one. Send events straight to the Hintway endpoint with the REST API.

---

3. Initialize the SDK

Initialization is the same idea everywhere: tell the SDK which project the data belongs to. The server URL is always the official Hintway endpoint, https://in.hintway.app. The only value specific to you is your Tenant ID:

1. Back in the Hintway dashboard, open Project Settings
2. Copy your Tenant ID
3. In your code (or your engine’s editor), call Init with the server URL, your Tenant ID, and a platform string (for example, PC, STEAM, IOS)

Init(
  url        = "https://in.hintway.app",   // Official Hintway endpoint (same for every project)
  tenantId   = "your-tenant-id",           // Tenant ID from Project Settings
  platform   = "PC"                        // Where the build runs
)

The exact call differs per SDK (a Blueprint/editor node in a game engine, a method call in code), but the three inputs are identical. See your SDK page for the precise syntax.

Caution

Init must run once, before any event is tracked, typically at startup, in your game mode, app entry point, or a login script.

---

4. Track your first event

With the SDK initialized, tracking an event is a single call. Pick a meaningful action in your app (a jump, a level start, a button press, a purchase) and track it where that action happens.

TrackEvent("jump")

That’s it: every time the player jumps, Hintway receives a jump event.

• Use clear, lowercase event names like jump, level_started, or item_bought.
• Need more detail? Attach properties (key/value pairs) to the same call for deeper analytics later.

Note

Refer to your SDK page for the exact event API, batching options, and how to attach properties or persistent custom data.

---

5. Generate some data

You need a bit of data before the dashboard has anything to show.

1. Build and run your project
2. Trigger your event a few times (jump three times)
3. Stop and restart the app, then trigger it a few more times. This creates a second session

Running across two sessions gives the dashboard something meaningful to break down by user and session.

---

6. Build a widget with AI

Return to the Hintway dashboard and refresh. It now populates with users, sessions, duration, platform, version, and your events.

1. Click Add Widget and open the AI tab
2. Ask in plain English. For example: “Show me the number of jumps of a user per session”
3. Apply the generated query
4. Refine it conversationally. For example: “I prefer a bar chart”, then apply the update
5. Preview the result and click Create Widget

Hintway turns your question into a ClickHouse query and a visualization automatically. Prefer to write SQL yourself? You can; see Query modes.

---

You’re all set

Hintway is now connected to your project, tracking events, and turning them into real-time dashboards you can shape with AI or SQL.

Widgets overview Every widget type and how to build dashboards.

Query modes Simple mode vs. full SQL.

Filters & presets Scope dashboards by platform, version, or any dimension.

Browse the SDKs Batching, custom data, and platform specifics.