Quickstart

Get your first event tracked in under 5 minutes.

Prerequisites

• An account at app.trichidata.com
• A project created inside your workspace

Step 1 — Get your API key

1. Open your project in the dashboard
2. Go to Settings → API Keys
3. Copy the write key (prj_ak_...)

Step 2 — Choose your SDK

Pick the package that matches your environment:

# Browser
npm install @trichidata/browser

# React
npm install @trichidata/react

# React Native
npm install @trichidata/react-native

# Node.js
npm install @trichidata/node

How sessions work

Every SDK follows the same flow:

1. init_sdk — authenticate with your API key. The server creates a session and sets the sdk_session cookie.
2. identify (optional) — associate userId and/or appVersion with the session. At least one field is required; omitted values default to "anonymous" and "unknown" in events.
3. Track events — use typed helpers (page, productViewed, …) or trackCustom.

The API attaches user_id, session_id, and project_id server-side — you do not send them in the event body. Event field names, schemas, and property limits are in the REST API.

Step 3 — Initialize

React

Wrap your app with TrichiDataProvider. It creates a TrichiDataClient, calls init_sdk automatically, and stores the sdk_session cookie in the browser.

import { TrichiDataProvider } from '@trichidata/react';

function App() {
  return (
    <TrichiDataProvider apiKey="prj_ak_xxxxxxxxxxxx">
      <YourApp />
    </TrichiDataProvider>
  );
}

Browser

import { TrichiDataClient } from '@trichidata/browser';

const client = new TrichiDataClient({ apiKey: 'prj_ak_xxxxxxxxxxxx' });
await client.init();

Node.js

import { TrichiDataClient } from '@trichidata/node';

const client = new TrichiDataClient({
  apiKey: 'prj_ak_xxxxxxxxxxxx',
});

await client.init({
  device: {
    ip: '203.0.113.42',
    userAgent: 'MyService/1.0 (Node)',
    locale: 'en-US',
    timezone: 'UTC',
  },
});

The client calls POST /api/v1/init_sdk against https://sdk-api.trichidata.com.

Step 4 — Identify a user (optional)

await client.identify({ userId: 'usr_7f3a9b2c', appVersion: '2.4.1' });

In React, get the client from context:

import { useTrichiData } from '@trichidata/react';

function Profile() {
  const client = useTrichiData();

  const handleLogin = () => {
    void client.identify({ userId: 'usr_7f3a9b2c', appVersion: '2.4.1' });
  };

  return <button onClick={handleLogin}>Log in</button>;
}

Step 5 — Send your first event

await client.page({
  url: 'https://example.com/',
  title: 'Home',
});

Or a custom event:

await client.trackCustom('promo_banner_click', { slot: 'hero' });

That's it. Open your project dashboard — you should see the event within a few seconds.

What's next

• Browser SDK — vanilla JS and frameworks
• React SDK — Provider and hooks
• React Native SDK — mobile apps
• Node SDK — server-side tracking
• REST API — event types, property schemas, and HTTP reference
• Table Builder — build reports from your event data
• Destinations — forward events to GA4 or Facebook Pixel