Package NPM | Convertmax Docs

Utilisez @convertmax/js lorsque vous souhaitez installer Convertmax via le bundle de votre application plutôt que via le snippet de script du site.

Installer le package

npm install @convertmax/js

createConvertmax() est la fonction de fabrique client canonique pour le package publié.

Utilisation dans le navigateur

Créez un client et pointez-le vers le point de terminaison d’événements Convertmax :

import { createConvertmax } from "@convertmax/js";

const convertmax = createConvertmax({
  host: "https://event.convertmax.io",
  apiKey: "YOUR_API_KEY",
  autoPage: true
});

await convertmax.page("Pricing");

await convertmax.track("click", {
  target: "hero_cta",
  page: "https://example.com/pricing"
});

`autoPage`

Lorsque autoPage: true est activé dans le navigateur, le client émet automatiquement page_view :

au chargement initial de la page après l’initialisation
après history.pushState et history.replaceState
lors de la navigation avant/arrière via popstate
lorsque seule la chaîne de requête change

Les changements de hash seul sont ignorés par défaut.

Comportements automatiques du navigateur

Une fois initialisé dans le navigateur, le SDK publié peut aussi automatiquement :

détecter les identifiants de clic publicitaire comme gclid, msclkid, ttclid, fbclid, et les identifiants de campagne associés, puis émettre un événement cpc
classifier les référents organiques et émettre organic
classifier les référents sociaux et émettre social
classifier les référents de moteurs de recherche et émettre search lorsqu’un terme de recherche est disponible
remplir les champs de formulaire cachés nommés cm_visitor et cm_session
capturer optionnellement le cf_uvid Clickfunnels depuis le stockage du navigateur lorsque captureCfUvid: true
détecter les navigateurs mobiles et inclure cet état dans les événements automatiques du navigateur
respecter l’état d’opt-out local

Utilisation Node.js

Utilisez le même package pour le suivi backend ou côté serveur avec runtime: "node" :

import { createConvertmax } from "@convertmax/js";

const convertmax = createConvertmax({
  host: "https://event.convertmax.io",
  apiKey: process.env.CONVERTMAX_API_KEY,
  runtime: "node"
});

await convertmax.track("convert", {
  event_name: "order_checkout_completed",
  source: "api",
  revenue: 149.99
});

Si votre runtime Node.js n’expose pas fetch, passez-en un via l’option fetch.

Aides de cycle de vie navigateur et opt-out

Le package publié inclut aussi :

config(options?) pour une configuration du cycle de vie navigateur à l’ancienne
optoutTracking()
optinTracking()
optoutStatus()
convertmaxLoaded lorsque le client navigateur est créé
convertmaxReady une fois les comportements automatiques du navigateur initialisés

Envoyer les événements de base

Après la configuration, suivez au moins un affichage de page et un événement de conversion :

await convertmax.track("page_view", {});

Vérifier l’installation

Après le chargement de votre application ou l’envoi d’un événement serveur :

confirmez que le SDK s’initialise correctement
confirmez qu’un événement page_view est émis
déclenchez un événement suivi comme click, add_cart, ou convert
confirmez que les requêtes sont envoyées vers https://event.convertmax.io

Utilisez la Convertmax Chrome Extension pour inspecter les signaux runtime et les requêtes capturées dans les environnements navigateur.