Guides d’installation

Installer depuis npm

Le paquet npm contient le même traceur que la balise script, avec les types TypeScript, pour les applications construites avec un bundler.

Installez le paquet

TerminalShell

npm install @webmetric/sdk

Démarrez le traceur

Votre fichier d’entréeTypeScript

import { init } from "@webmetric/sdk";

init({
  key: "wm_w_your_write_key",
  host: "https://in-stg.webmetric.io",
  assetOrigin: "https://cdn-stg.webmetric.io/v1",
});

Appelez init() une seule fois, le plus tôt possible dans le navigateur. Un second appel renvoie le traceur déjà lancé au lieu d’en démarrer un autre.

Pendant le rendu côté serveur, init() ne fait rien et renvoie undefined : vous pouvez l’importer sans risque dans du code partagé.

Différences avec la balise script

Les options sont passées à init() au lieu d’attributs data-, et certains noms diffèrent. Elles sont listées dans options de init().
Les appels à track() faits avant init() sont conservés, jusqu’à 50, et envoyés dès son exécution.
Les fichiers d’enregistrement de session et de capture de page se chargent toujours depuis le CDN quand votre projet les utilise : une Content Security Policy doit donc l’autoriser.

Envoyez un événement personnalisé

N’importe où dans votre applicationTypeScript

import { track } from "@webmetric/sdk";

track("signup_completed", { plan: "growth", seats: 3 });

Les règles de nom et les limites des propriétés sont dans événements personnalisés.

Vérification

Lancez votre application, ouvrez une page dans le navigateur, puis ouvrez la vue d’ensemble. Le panneau d’installation confirme le premier événement. Si rien n’arrive, consultez le dépannage.