{"_id":"@plausible-analytics/tracker","_rev":"10-fb04cecb2fc9b7ffa4af1402e81b86a4","name":"@plausible-analytics/tracker","dist-tags":{"latest":"0.4.6"},"versions":{"0.3.6":{"name":"@plausible-analytics/tracker","version":"0.3.6","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.3.6","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"3969818759338e767bd1b154c9df79c34bb6b7a4","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.3.6.tgz","fileCount":7,"integrity":"sha512-e3S7Wu5l4ZjJwAiQsIWUJ9USQh4P+GBD/kFo4Hum14LPwEifNYhRvGLANjwt08KLzfswT8JJjK4qKEyI4YTmWw==","signatures":[{"sig":"MEUCIQDiYkPmUJf/VXV9rRGa0k1Qb4BMY1XxLvYFnUX6x+fFlAIgAof5WrWGLaDvjVx+1yNxnrqtSHTjfLyTfLjxiUHtj1g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23268},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"5807878a18da59a8c00a55a90c51df870ce54db2","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.3.6_1754906906221_0.4156211337018898","host":"s3://npm-registry-packages-npm-production"}},"0.4.0":{"name":"@plausible-analytics/tracker","version":"0.4.0","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.0","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"b5a5f66661ef4088ec6c0ccfa7a23f18078ba7c7","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.0.tgz","fileCount":6,"integrity":"sha512-KXwttotIZymo3yGzargrsxl9hjXJo5N+Kips3ZMamYqJxJqv1Zx+POC6WOFxYwDe1iJW7T91ItQYD8mZsznpXQ==","signatures":[{"sig":"MEUCIDNntUJtzIlsTR1fmxygviLvenkeblpMo0rIj6CjLrt6AiEAhepc6dTqN5wQ6p+zb2FC8Fr0aydrnriR/qcrf1sIqE8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18530},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"a457ec50083b4a9b3e033c6b48058b98059483e0","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.0_1754981883917_0.28451150072562426","host":"s3://npm-registry-packages-npm-production"}},"0.4.1":{"name":"@plausible-analytics/tracker","version":"0.4.1","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.1","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"8b5ba08ce95a2936d75951f4f8d036208f72f9d4","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.1.tgz","fileCount":6,"integrity":"sha512-pXhP7ebUUhlQ9HviRxW/nTchmP4m7+MKgfktD+M7YVPw+AAtiwnLriqp1qVNviccRS0HNaM9aEcpQHI7sBrPkg==","signatures":[{"sig":"MEYCIQDKzZN+v3nc5mCpzN/Ml1tG/f68tH9fWvFPB124TRdTawIhAJbPwznloXtWPHAtSGguH4/vp+2aNrI9PgnWKtZc7yCQ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18643},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"af06df806b4e723546d078ed329869e3fa03ff51","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.1_1756706319720_0.8639398552048856","host":"s3://npm-registry-packages-npm-production"}},"0.4.2":{"name":"@plausible-analytics/tracker","version":"0.4.2","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.2","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"68c0d968dda7a951bf38c336538773bf6bf8f67e","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.2.tgz","fileCount":6,"integrity":"sha512-WMaPsinJx9YUFptlm45YufRrK0kEyiZnRPCDDbPmERIXB9PllCuBgh7WiT0qPRaE6qTgbxi2sZ5wLCU73bQMBg==","signatures":[{"sig":"MEYCIQD0qKiVUD6KLI62Eygdp6m9ORa2xDtcZwRM+ygM5encmwIhAJ78OB4FKUIzlFCDvSg6Nyn6zifKKIdbJmPOsifossFC","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":18789},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"757cf95070361d28e54d22ff92302b6ebec38b5b","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.2_1756962023014_0.8081996740627908","host":"s3://npm-registry-packages-npm-production"}},"0.4.3":{"name":"@plausible-analytics/tracker","version":"0.4.3","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.3","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"d7d85c088c6b091ef07bbdea761f49d9bd58ae14","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.3.tgz","fileCount":6,"integrity":"sha512-RKTgH5xu7Pa77VS4OEnS4woPhDxRgWLJlt9f6JhwgBC9ilknCfJIVEN2A1D8OR7hzgxMQF/hPyls9iN9ReAm3Q==","signatures":[{"sig":"MEQCIAk0s6jbqX1i+UIv4olnUtCiV7c33rak9ws9mbWw6XKcAiBWPXx2/yeTsxW3fEoERwGctqMMhunjDniG1RkEA5KtpA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22297},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"cc5ca4b752ec3a7d51f1298656fe7949681e9869","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.3_1757935531733_0.17290273611259765","host":"s3://npm-registry-packages-npm-production"}},"0.4.4":{"name":"@plausible-analytics/tracker","version":"0.4.4","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.4","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"135e67d722d3161bffd143274db25cf5b45f481b","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.4.tgz","fileCount":6,"integrity":"sha512-fz0NOYUEYXtg1TBaPEEvtcBq3FfmLFuTe1VZw4M8sTWX129br5dguu3M15+plOQnc181ShYe67RfwhKgK89VnA==","signatures":[{"sig":"MEUCIQCqcg4JaClSOdl920eAlqzQUioV46VAgptraB9ULG+p8wIgOL0Anv6NBtjR4aeZsr5/gWYk61SbIOQTMcocikd+7U4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22662},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"c9cbea7cd8e37b6cc214072c1fb7b0df395ad93f","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"macobo","email":"oxymaccy@gmail.com"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.4_1761897651912_0.23661201797978593","host":"s3://npm-registry-packages-npm-production"}},"0.4.5":{"name":"@plausible-analytics/tracker","version":"0.4.5","keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","_id":"@plausible-analytics/tracker@0.4.5","maintainers":[{"name":"macobo","email":"oxymaccy@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"homepage":"https://plausible.io","bugs":{"url":"https://github.com/plausible/plausible/issues"},"dist":{"shasum":"9f0cbebc945a0ac59e27f57540da984d82def449","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.5.tgz","fileCount":6,"integrity":"sha512-6BfAGejXY+YA3Cw6LYT2Zpn4hTxDtPQAawFsYUsQCOg78wIS5C4deAGXTfJffa5VleMWITv5lpJ/EYuQBl1tPA==","signatures":[{"sig":"MEUCIBSVlOWLbaN0WW9n16vAf/ayaVMkWBfHJ2taOAFAB9OhAiEAsz96amqybjrlEWOniajUDykEWo+OJXjfh2HX/3+zDv4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22624},"type":"module","types":"./plausible.d.ts","module":"./plausible.js","gitHead":"49448f5b16a5923ce06b200833a04de0e037b5e9","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"_npmUser":{"name":"ukutaht","email":"uku@plausible.io"},"repository":{"url":"git+https://github.com/plausible/plausible.git","type":"git"},"_npmVersion":"10.9.0","description":"Plausible Analytics official frontend tracking library","directories":{},"_nodeVersion":"23.2.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/tracker_0.4.5_1777986681352_0.4855622644399231","host":"s3://npm-registry-packages-npm-production"}},"0.4.6":{"name":"@plausible-analytics/tracker","version":"0.4.6","description":"Plausible Analytics official frontend tracking library","scripts":{"test":"echo \"Error: Testing done in the tracker folder\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/plausible/analytics.git"},"keywords":["web-analytics","website-analytics","analytics"],"author":{"name":"Plausible Analytics"},"license":"MIT","homepage":"https://plausible.io","type":"module","module":"./plausible.js","types":"./plausible.d.ts","exports":{".":{"types":"./plausible.d.ts","default":"./plausible.js"}},"gitHead":"607f3c733fd068ed58fc7bed3385a47c755adb06","_id":"@plausible-analytics/tracker@0.4.6","bugs":{"url":"https://github.com/plausible/analytics/issues"},"_nodeVersion":"24.17.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-nbu6xGgSP6jeYuoVklZBzucUnIpo75tVu3Kr+R0EDycVKaMC/jF5Q/YCaM/8gR4fPZ1IDcXt6FdBJFZ1uZwEPA==","shasum":"e77a2043fb8dee65508b568de7d6e7cfbcddd7d2","tarball":"https://registry.npmjs.org/@plausible-analytics/tracker/-/tracker-0.4.6.tgz","fileCount":6,"unpackedSize":22882,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@plausible-analytics%2ftracker@0.4.6","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDiDFoCBkO6jrhirPTYd2vFqS6aVO50iY4Pl6QQ1eJpUQIgMX5CU8goKy4w41TlAiNQbVHHOu2/cEQdGfhCfe5GoSE="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:d9cb6b7c-6ab1-4c5a-80ca-31f87ab082b2"}},"directories":{},"maintainers":[{"name":"apostroof","email":"artur.pata@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/tracker_0.4.6_1786361466605_0.9206958558420388"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-11T10:08:26.077Z","modified":"2026-08-10T11:31:07.255Z","0.3.6":"2025-08-11T10:08:26.464Z","0.4.0":"2025-08-12T06:58:04.127Z","0.4.1":"2025-09-01T05:58:39.899Z","0.4.2":"2025-09-04T05:00:23.220Z","0.4.3":"2025-09-15T11:25:31.925Z","0.4.4":"2025-10-31T08:00:52.111Z","0.4.5":"2026-05-05T13:11:21.497Z","0.4.6":"2026-08-10T11:31:06.760Z"},"bugs":{"url":"https://github.com/plausible/analytics/issues"},"author":{"name":"Plausible Analytics"},"license":"MIT","homepage":"https://plausible.io","keywords":["web-analytics","website-analytics","analytics"],"repository":{"type":"git","url":"git+https://github.com/plausible/analytics.git"},"description":"Plausible Analytics official frontend tracking library","maintainers":[{"name":"apostroof","email":"artur.pata@gmail.com"},{"name":"ukutaht","email":"uku@plausible.io"}],"readme":"# Plausible Analytics tracker\n\n[![NPM](https://flat.badgen.net/npm/v/@plausible-analytics/tracker)](https://www.npmjs.com/package/@plausible-analytics/tracker)\n[![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)\n\nAdd [Plausible Analytics](https://plausible.io/) to your website.\n\n## Features\n\n- Small package size\n- Same features and codebase as the official script, but as an NPM module\n- Automatically track page views in your SPA apps\n- Track goals and custom events\n- Provide manual values that will be bound to the event\n- Full typescript support\n\n> **Important:** This library only works in browser environments. When using server-side rendering (SSR), the `init` and `track` functions will not work as they rely on browser APIs. Make sure to only initialize and track events on the client side.\n\n## Package Installation\n\nWith npm:\n\n```bash\nnpm install @plausible-analytics/tracker\n```\n\n## Usage\n\nTo begin tracking events, you must initialize the tracker:\n\n```javascript\nimport { init } from '@plausible-analytics/tracker'\n\ninit({\n domain: 'my-app.com'\n})\n```\n\n### Configuration options\n\nSee also [plausible.d.ts](https://github.com/plausible/analytics/blob/master/tracker/npm_package/plausible.d.ts) for typescript types.\n\n| Option | Description | Default |\n| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |\n| `domain` | **Required** Your site's domain, as declared by you in Plausible's settings. | |\n| `endpoint` | The URL of the Plausible API endpoint. See proxying guide at https://plausible.io/docs/proxy/introduction | `\"https://plausible.io/api/event\"` |\n| `autoCapturePageviews` | Whether to automatically capture pageviews. | `true` |\n| `hashBasedRouting` | Whether the page uses hash based routing. Read more at https://plausible.io/docs/hash-based-routing | `false` |\n| `outboundLinks` | Whether to track outbound link clicks. | `false` |\n| `fileDownloads` | Whether to track file downloads. | `false` |\n| `formSubmissions` | Whether to track form submissions. | `false` |\n| `captureOnLocalhost` | Whether to capture events on localhost. | `false` |\n| `logging` | Whether to log on ignored events. | `true` |\n| `customProperties` | Object or function that returns custom properties for a given event. | `{}` |\n| `transformRequest` | Function that allows transforming or ignoring requests | |\n| `bindToWindow` | Binds `track` to `window.plausible` which is used by Plausible installation verification tool to detect whether Plausible has been installed correctly. If `bindToWindow` is set to false, the installation verification tool won't be able to automatically detect it on your site. | `true` |\n\n#### Using `customProperties`\n\nTo track a custom property with every page view, you can use the `customProperties` configuration option:\n\n```javascript\ninit({\n domain: 'my-app.com',\n customProperties: { content_category: 'news' }\n})\n```\n\n`customProperties` can also be a dynamic function:\n\n```javascript\ninit({\n domain: 'my-app.com',\n customProperties: (eventName) => ({ title: document.title })\n})\n```\n\n### Tracking custom events\n\nTo track a custom event, call `track` and give it the name of the event. Custom properties can be passed as a second argument:\n\n```javascript\nimport { track } from '@plausible-analytics/tracker'\n\ntrack('signup', { props: { tier: 'startup' } })\n```\n\nTo mark an event as non-interactive so it would not be counted towards bounce rate calculations, set `interactive` option:\n\n```javascript\ntrack('autoplay', { interactive: false })\n```\n\n### Revenue tracking\n\nTo track an event with revenue information, do:\n\n```javascript\nimport { track } from '@plausible-analytics/tracker'\n\ntrack('Purchase', { revenue: { amount: 15.99, currency: 'USD' } })\n```\n\nMore information can be found in [ecommerce revenue tracking docs](https://plausible.io/docs/ecommerce-revenue-tracking)\n\n### Callbacks\n\nWhen calling `track`, you can pass in a custom callback.\n\n```javascript\nimport { track } from '@plausible-analytics/tracker'\n\ntrack('some-event', {\n callback: (result) => {\n if (result?.status) {\n console.debug('Request to plausible done. Status:', result.status)\n } else if (result?.error) {\n console.log('Error handling request:', result.error)\n } else {\n console.log('Request was ignored')\n }\n }\n})\n```\n\n### Opt out and exclude yourself from the analytics\n\nSince plausible-tracker is bundled with your application code, using an ad-blocker to exclude your visits isn't an option. Fortunately Plausible has an alternative for this scenario: plausible-tracker will not send events if `localStorage.plausible_ignore` is set to `\"true\"`.\n\nMore information about this method can be found in the [Plausible documentation](https://plausible.io/docs/excluding-localstorage).\n","readmeFilename":"README.md"}