Quickstart

Connect your website with one installation path. Select the intended store, then open Bily > Settings > Apps > More settings > Install tracking. Choose your site’s technology and copy the complete script or SDK snippet, including every query parameter and encoded character.

Install Bily once

Use the raw script for plain HTML. Use @bilyai/js for browser application frameworks.

Plain HTML
Application SDK

Add the exact script once inside the global <head>.

index.html

<script
  src="https://tracking.example.com/b.js?shop=store.example.com"
  referrerpolicy="strict-origin-when-cross-origin"
></script>

Install the Bily package.

npm install @bilyai/js

Initialize Bily once in browser code.

analytics.ts

import { init } from "@bilyai/js";

init({
  scriptUrl: "https://tracking.example.com/b.js?shop=store.example.com",
});

Record each page once

The browser script records the first PageView automatically. Do not call track("PageView") during the initial mount.If your application changes routes without loading a new document, track each later route after the router commits the change.

analytics.ts

import { track } from "@bilyai/js";

track("PageView", {
  sourceUrl: window.location.href,
  pageTitle: document.title,
});

Send your first event

Give your application events stable snake_case names.

analytics.ts

import { track } from "@bilyai/js";

track("workspace_created", {
  workspace_id: "workspace_456",
  user_id: "user_123",
});

Confirm Bily is ready

The SDK queues calls while Bily loads, so normal tracking does not need to wait. Use ready() only for an explicit load check.

verify-bily.ts

import { ready } from "@bilyai/js";

try {
  await ready();
  console.info("Bily is ready");
} catch (error) {
  console.error("Bily did not load", error);
}

Getting started

Plan and launch

Install Bily

Track events

Operate safely

Continue with your framework

All frameworks

React Router

Next.js

​Continue with your framework

All frameworks

React Router

Next.js

Continue with your framework