getting-started

Installeer Flowsery Analytics als npm-pakket voor typeveilige eventtracking in JavaScript- en TypeScript-projecten. Werkt met React, Next.js, Vue, Angular en elk ander webframework.

Waarom de SDK gebruiken?

  • TypeScript-ondersteuning, volledige typedefinities voor autocomplete en controles tijdens het compileren
  • Tree-shakeable, importeer alleen de onderdelen die je nodig hebt
  • Frameworkonafhankelijk, werkt met React, Vue, Angular, Svelte, React Native / Expo en vanilla JS
  • Automatische tracking, ingebouwde verzameling van paginaweergaven, sessies en apparaten
  • Klaar voor offline, zet events in de wachtrij zolang je offline bent en verstuurt ze zodra er weer verbinding is

Installatie

npm install flowsery

Snelstart

Basisinstallatie

Basisinitialisatie
import { initFlowsery } from 'flowsery';

const flowsery = await initFlowsery({
  websiteId: 'flid_******',
  domain: 'your_domain.com',
});

// Track custom events
flowsery.trackEvent('signup', { email: 'user@example.com' });

// Identify users
flowsery.identify({ userId: 'user_123', email: 'user@example.com', name: 'John Doe' });

Voorbeeld voor React / Next.js

lib/analytics.ts
import { initFlowsery } from 'flowsery';

let flowsery: any = null;

export async function getAnalytics() {
  if (!flowsery) {
    flowsery = await initFlowsery({
      websiteId: process.env.NEXT_PUBLIC_FLOWSERY_WEBSITE_ID!,
      domain: process.env.NEXT_PUBLIC_FLOWSERY_DOMAIN,
    });
  }
  return flowsery;
}

Voorbeeld voor React Native / Expo

Root layout
import { FlowseryProvider } from 'flowsery/react-native';

export default function RootLayout() {
  return (
    <FlowseryProvider
      config={{
        websiteId: process.env.EXPO_PUBLIC_FLOWSERY_WEBSITE_ID!,
        domain: process.env.EXPO_PUBLIC_FLOWSERY_DOMAIN!,
        local: __DEV__,
      }}>
      {/* your navigation / screens here */}
    </FlowseryProvider>
  );
}

Configuratieopties

FlowseryConfig-interface
interface FlowseryConfig {
  websiteId: string;
  domain?: string;
  apiBase?: string;
  local?: boolean;             // default: false
  cookieless?: boolean;        // default: false
  allowFileProtocol?: boolean; // default: false
  allowIframe?: boolean;       // default: false
  disablePayments?: boolean;   // default: false
  disableConsole?: boolean;    // default: false
  allowedHostnames?: string[];
  hashMode?: boolean;          // default: false
}

API-methoden

trackEvent

Volg aangepaste events met optionele metadata.

flowsery.trackEvent('button_click');
flowsery.trackEvent('purchase', { amount: 99.99, currency: 'USD', product: 'Premium Plan' });

trackPayment

Volg betaalevents met bedrag, valuta en metadata.

flowsery.trackPayment({ amount: 49, currency: 'USD', email: 'user@example.com' });

trackPageview

Volg handmatig een paginaweergave.

flowsery.trackPageview();

identify

Identificeer de huidige bezoeker met gebruikersgegevens.

flowsery.identify({ userId: 'user_123', email: 'user@example.com', name: 'John Doe' });

stop

Stop de tracker en verstuur alle events in de wachtrij.

flowsery.stop();

reset

Reset de clientstatus (wist bezoekers- en sessiegegevens).

flowsery.reset();

getVisitorId / getSessionId

Haal de huidige bezoekers- of sessie-ID op.

const visitorId = flowsery.getVisitorId();
const sessionId = flowsery.getSessionId();

Cross-domain tracking (SDK)

const params = flowsery.getTrackingParams();
const url = flowsery.buildCrossDomainUrl('https://myapp.io/signup');

Pakketstructuur

  • flowsery, hoofd-SDK voor webapplicaties (localStorage, fetch-adapters)
  • flowsery/react-native, implementatie voor React Native / Expo (AsyncStorage, NetInfo, Expo device)

Hulp nodig?

Bekijk de referentie voor scriptconfiguratie voor geavanceerde opties zoals tracking op localhost, een proxy instellen en cross-domain configuratie.