Skip to main content

API Reference

MatomoProvider

<MatomoProvider config={matomoConfig} debug queueLimit={50}>
<MatomoAutoPageView />
<App />
</MatomoProvider>

Props:

PropTypeDefaultDescription
configobjectRequired: your Matomo config
debugbooleanfalsePrint debug logs
queueLimitnumber50Max queue size

useTrack()

const { track } = useTrack();

track("cat.click", {
name: "Clicked Cat",
value: 1,
});

useMatomo()

const {
trackPageView,
setUserId,
resetUserId,
setCustomDimension,
setUserProperties,
setTrackingEnabled,
queueSize,
lastFlushTimestamp,
droppedEventsCount,
} = useMatomo();

MatomoAutoPageView

<MatomoAutoPageView />

Automatically tracks page views on route changes.


That’s the full API 🚀

Next: see some Examples!