@codux-pond/analytics

Wix BI Analytics

The @codux-pond/analytics package provides a set of tools to log and transport Business Intelligence (BI) events for Wix headless applications. It includes a main class WixBiAnalytics for reporting page views and other events, as well as various transport mechanisms for sending these events to a server.

Installation

To install the package, use npm or yarn:

npm install @codux-pond/analytics
# or
yarn add @codux-pond/analytics

Usage

Importing the Package

import {
  WixBiAnalytics,
  fetchTransport,
  imgTransport,
  beaconTransport,
  fallbackTransports,
} from '@codux-pond/analytics';

Creating an Instance

Create an instance of WixBiAnalytics by providing an array of transport functions and optional context providers.

import { WixBiAnalytics, getVisitorId, getViewerSessionId } from '@codux-pond/analytics';

const visitorId = getVisitorId();
const viewerSessionId = getViewerSessionId();

const logger = new WixBiAnalytics(
  () => ({
    metaSiteId: 'your-meta-site-id',
    visitorId,
    viewerSessionId,
  }),
  console.error
);

Reporting a Page View

Use the reportPageView method to log a page view event.

logger.reportPageView();

Transports

Transports are detected automatically based on the environment. You can also specify a transport function manually. There are several transport functions available for sending BI events to a server. You can use one of these functions or create your own.

fetchTransport function sends BI events using Fetch API.

imgTransport function sends BI events by creating an image element.

beaconTransport function sends BI events using the Beacon API.

Fallback Transports

The fallbackTransports function tries multiple transport methods in sequence until one succeeds.

import {
  fallbackTransports,
  fetchTransport,
  imgTransport,
  beaconTransport,
} from '@codux-pond/analytics';

const transport = fallbackTransports([fetchTransport, imgTransport, beaconTransport]);