engagement

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

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

export const analytics = createAnalytics({
  project: "example.com",
  key: "pk_...",
  endpoint: "/_ra",
  plugins: [engagement()],
});

OptionsCopy Anchor Link

engagement() takes no options.

SendsCopy Anchor Link

BehaviourCopy Anchor Link

• The clock runs only while document.visibilityState is visible. Time in a background tab does not count.
• The total is sent when the next pageview happens or when the tab is hidden, then it starts again from 0. A total of 0 sends nothing.
• The event is credited to the page that was viewed, not the page navigated to.

In reportsCopy Anchor Link

engagement events are stored like any custom event: filter[event]=engagement with metrics=avg:prop.ms averages them. The time_on_page metric does not use them; it is the gap to the session's next pageview. engagement events are not listed among a visit's actions.