Rybbit Analytics
Get started with Rybbit Analytics
Rybbit Analytics is a privacy-focused analytics solution for tracking user activity on your website without compromising your users' privacy.
Nuxt Config Setup
The simplest way to load Rybbit Analytics globally in your Nuxt App is to use Nuxt config. Alternatively you can directly use the useScriptRybbitAnalytics composable.
export default defineNuxtConfig({
scripts: {
registry: {
rybbitAnalytics: {
siteId: '10001'
}
}
}
})useScriptRybbitAnalytics()
The useScriptRybbitAnalytics composable lets you have fine-grain control over when and how Rybbit Analytics is loaded on your site.
const { proxy } = useScriptRybbitAnalytics()
proxy.event('conversion', { value: 1 })Please follow the Registry Scripts guide to learn more about advanced usage.
First-Party Mode
This script supports First-Party Mode which is auto-enabled, routing all traffic through your domain for improved privacy and ad blocker bypass.
export default defineNuxtConfig({
scripts: {
registry: {
rybbitAnalytics: {
siteId: '10001'
}
}
}
})Example
Using Rybbit Analytics only in production while using the proxy to send events.
<script setup lang="ts">
const { proxy } = useScriptRybbitAnalytics()
// noop in development, ssr
// just works in production, client
function handleAction() {
proxy.event('conversion', { value: 1 })
}
</script>
<template>
<div>
<button @click="handleAction">
Send Event
</button>
</div>
</template>Self-hosted Rybbit Analytics
If you are using a self-hosted version of Rybbit Analytics, you can provide a custom script source:
useScriptRybbitAnalytics({
scriptInput: {
src: 'https://your-rybbit-instance.com/api/script.js'
},
siteId: 'YOUR_SITE_ID'
})
siteIdstring | number required Your Rybbit site ID.
autoTrackPageviewboolean = trueAutomatically track page views.
trackSpaboolean = trueEnable SPA (single-page app) route tracking.
trackQuerybooleanInclude query parameters in tracked URLs.
trackOutboundbooleanTrack outbound link clicks.
trackErrorsbooleanTrack JavaScript errors.
sessionReplaybooleanEnable session replay recording.
webVitalsbooleanEnable Web Vitals tracking (LCP, FID, CLS, etc.).
skipPatternsstring[]URL patterns to skip from tracking (glob syntax).
maskPatternsstring[]URL patterns to mask in tracked data (glob syntax).
debouncenumberDebounce interval (in ms) for page view tracking.
apiKeystringAPI key for authenticated tracking.
analyticsHoststringOverride the analytics host URL. When first-party mode is enabled, this is auto-injected to route through the proxy. The SDK derives its API endpoint from the script src, so this changes the script src to `${analyticsHost}/script.js`.