Repository navigation
feat: Privatus Analytics #974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ja-andrews
wants to merge
1
commit into
nuxt:main
Choose a base branch
from
ja-andrews:feat/privatus-analytics
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| title: Privatus Analytics | ||
| description: Load the Privatus Analytics tracker and record custom events. | ||
| links: | ||
| - label: Source | ||
| icon: i-simple-icons-github | ||
| to: https://github.com/nuxt/scripts/blob/main/packages/script/src/runtime/registry/privatus-analytics.ts | ||
| size: xs | ||
| --- | ||
|
|
||
| [Privatus Analytics](https://privatusanalytics.com/) is cookieless web analytics. The tracker sets no cookies and keeps no visitor ID in the browser. The only thing it stores is a visitor's own opt-out choice. The [docs](https://privatusanalytics.com/docs) list every tracker option. | ||
|
|
||
| A free plan covers 10,000 events a month on up to 3 sites. | ||
|
|
||
| ::script-stats | ||
| :: | ||
|
|
||
| ::script-docs | ||
| :: | ||
|
|
||
| ## Proxying is not supported | ||
|
|
||
| Privatus Analytics counts visitors from a daily salted hash of the connecting IP address and user agent. If your Nuxt server relays beacons, every visitor looks like your server. | ||
|
|
||
| You can bundle the tracker on your Nuxt origin. Beacons still go to the Privatus Analytics API. The composable always sets `data-api` on the script tag, so a bundled copy keeps posting to the right place. | ||
|
|
||
| ## Modules | ||
|
|
||
| `modules` turns on extra tracker modules, such as outbound links and downloads (`auto`), Core Web Vitals (`vitals`) and click maps (`clicks`). Without it, the tracker loads its default module, `engage`, which records time on page and scroll depth. Modules load at runtime from `api`, so bundling only covers the main script. | ||
|
|
||
| ```ts | ||
| useScriptPrivatusAnalytics({ | ||
| site: 'pa_YOURSITEID', | ||
| modules: ['engage', 'auto', 'vitals'], | ||
| }) | ||
| ``` | ||
|
|
||
| ## Custom events | ||
|
|
||
| Use `proxy.track(name, props)`{lang="ts"} to record an event. Calls made before the tracker loads run once it is ready. Properties can be strings, numbers, booleans or string arrays. `revenue` and `currency` record revenue. | ||
|
|
||
| ::code-group | ||
|
|
||
| ```ts [Proxy] | ||
| const { proxy } = useScriptPrivatusAnalytics() | ||
| function trackSignup() { | ||
| proxy.track('Signup', { plan: 'pro' }) | ||
| } | ||
| ``` | ||
|
|
||
| ```ts [onLoaded] | ||
| const { onLoaded } = useScriptPrivatusAnalytics() | ||
| onLoaded(({ track }) => { | ||
| track('Purchase', { revenue: 49, currency: 'USD' }) | ||
| }) | ||
| ``` | ||
|
|
||
| :: | ||
|
|
||
| You can also tag an element with `data-privatus-event="Signup"` and the tracker records clicks on it, or submits for a form. | ||
|
|
||
| ## Page views in Nuxt | ||
|
|
||
| The tracker counts client-side navigation through `history.pushState`, so Vue Router page views need no setup. To send page views yourself, set `manual: true` and call `proxy.pageview()`{lang="ts"}. | ||
|
|
||
| The tracker sends nothing on `localhost` or in automated browsers, so local development and browser tests do not record visits. | ||
|
|
||
| ::script-types | ||
| :: | ||
|
|
||
| ## Example | ||
|
|
||
| The default trigger waits until Nuxt is ready: | ||
|
|
||
| ```vue [app.vue] | ||
| <script setup lang="ts"> | ||
| useScriptPrivatusAnalytics({ | ||
| site: 'pa_YOURSITEID', | ||
| }) | ||
| </script> | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Explain how to disable automatic SPA page views.
If a Nuxt app calls
proxy.pageview()on each navigation,manual: truealone still lets the tracker count SPA navigations automatically. This guidance can therefore lead to duplicate page views. Tell users to setspa: 'off'as well when they manage every page view themselves. (privatusanalytics.com)