experiments

import { experiments } from "@spoar/sdk/plugins";

The plugin does not assign variants. Pass the variants your own code or feature flag service picked:

import { createAnalytics } from "@spoar/sdk";
import { experiments } from "@spoar/sdk/plugins";

export const analytics = createAnalytics({
  project: "example.com",
  key: "pk_...",
  endpoint: "/_ra",
  plugins: [experiments({ hero: "b", pricing: "annual-first" })],
});

OptionsCopy Anchor Link

SendsCopy Anchor Link

Every event sent after the plugin starts also carries one experiment:<id> prop per experiment. With the example above, a later signup carries:

{ "experiment:hero": "b", "experiment:pricing": "annual-first", plan: "pro" }

BehaviourCopy Anchor Link

• Exposures are sent when the plugin starts: once per page load when it is passed in plugins, or when analytics.use() adds it.
• The experiment:<id> props are added with analytics.register(), so they count toward the 25 props an event may carry, are remembered in localStorage across reloads when consent allows it, and are cleared by reset() and by revoking consent.
• Because registered props are remembered, an experiment removed from assigned stays on events until reset(). Registering the same id again replaces its variant.

In reportsCopy Anchor Link

The API records each exposure on the visitor, so a visitor's profile shows experiments: { "hero": "b" } and the visitors SQL view has an experiments column. breakdown/prop:variant with filter[event]=experiment_exposure and filter[prop:experiment]=hero counts exposures per variant.

The prop:<key> dimension accepts letters, digits, underscores, dots and dashes only, so the experiment:<id> props are read through SQL, for example props->>'experiment:hero' in the events view.