Справочник SDK

Все SDK шлют в один API (/v1/batch, /v1/identify, /v1/flags/evaluate) и используют общий формат событий. Ниже — выбор под стек.

Через npm:

npm install @trektik/browser

Или через CDN (IIFE, глобальный Trektik):

<script src="https://cdn.trektik.ru/sdk.js"></script>

API-ключ (pk_…) создаётся в админке проекта. Публичные ключи можно класть в клиентский код — они скопированы с рейт-лимитом и на стороне сервера.

init() создаёт singleton и автоматически стартует подсистемы — автозахват, записи сессий, тепловые карты, фрустрация, подсказки, опросы. Каждую можно отключить передачей false.

import { init } from '@trektik/browser';

const trektik = init({
  apiKey: 'pk_...',
  // автозахват, записи, тепловые карты, гайды, опросы — по умолчанию включены
});

trektik.track('checkout_started', { plan: 'pro', price: 4990 });
trektik.identify('user-42', { email: 'user@example.com' });
trektik.revenue({ amount: 4990, currency: 'RUB', productId: 'pro-monthly' });

Альтернативно — явный класс, если нужно подсистемами управлять вручную:

import { Trektik } from '@trektik/browser';

const trektik = new Trektik();
trektik.init({ apiKey: 'pk_...' });
// Подсистемы (autocapture, replay, ...) надо стартовать вручную.

При autocapture: true (по умолчанию) SDK шлёт системные события:

• $pageview — загрузка + SPA (pushState, replaceState, popstate, hashchange)
• $click — клики. Пропускаются input[type=password]
• $form_submit — без значений полей (для приватности)
• $scroll_depth — пороги 25 / 50 / 75 / 100%
• $session_start, $session_end
• $identify, $revenue — при вызове соответствующих методов

Исключить элемент из захвата — классом или атрибутом (каскадно):

<button class="trektik-no-capture">Не трекать</button>
<div data-trektik-no-capture>...</div>

Точечная настройка — передайте объект AutocaptureConfig:

init({
  apiKey: 'pk_...',
  autocapture: { pageViews: true, clicks: true, forms: true, scroll: false },
});

Полный справочник по системным событиям — на странице Системные события.

Использует rrweb под капотом. Шлёт чанки в POST /v1/replay/chunks (gzip, если доступен CompressionStream).

init({
  apiKey: 'pk_...',
  replay: {
    samplingRate: 100,            // % сессий (0–100)
    flushInterval: 10000,         // ms
    maxEventsPerChunk: 50,
    maxDuration: 1800000,         // 30 мин hard limit
    maskTextInput: true,          // маскировать input/textarea
    maskAllText: false,
    blockSelector: '.sensitive',  // полностью блокировать узлы
    compress: true,
  },
});

Сэмплинг фиксируется один раз при создании SDK. Отключить полностью: replay: false.

SDK опрашивает бэкенд (GET /v1/decide/guides, /v1/decide/surveys) и рендерит оверлеи в DOM. Стили инжектятся автоматически, можно переопределить.

Поддерживаемые типы guides:

• tooltip — относительно CSS-селектора
• banner — fixed top/bottom
• modal — с полупрозрачным overlay
• slideout — боковая панель
• multi_step_tour — последовательный тур
• checklist — floating-виджет (bottom-right)

Типы surveys:

• nps — шкала 0–10
• csat — звёзды 1–5
• open_ended — свободный текст
• multiple_choice — радио

A/B тестирование: гайд или опрос может ссылаться на флаг функции через flag_key + variants[]. SDK разрешает вариант через POST /v1/flags/evaluate перед рендерингом.

const trektik = init({ apiKey: 'pk_...', consentRequired: true });

// до consent — события буферизуются в памяти, НЕ идут на сервер
trektik.track('button_click');
trektik.hasConsent();        // false

// Consent получен:
trektik.grantConsent();      // буфер уходит; дальше — обычная работа

// Пользователь отозвал:
trektik.revokeConsent();     // стирает весь localStorage, SDK деинициализируется
// Чтобы возобновить — надо снова вызвать init() + grantConsent()

IP-адреса хешируются на сервере (projects.ip_anonymization = true по умолчанию).

• browser.global.js (минифицированный IIFE, все подсистемы + rrweb): ~241 KB (~70 KB gzip)
• index.mjs (ESM): ~64 KB

Основной объём — rrweb. В 0.1.x базовый бандл был ~8 KB; рост случился после добавления записей сессий, тепловых карт, фрустрации и подсказок. Если эти модули не нужны, отключите их в конфиге — tree-shaking не удалит их, зато подсистемы не запустятся и не потянут события.