Skip to main content

Script extensions for enhanced measurement

We're proud to have one of the most lightweight JavaScript snippets in the analytics industry. Clocking in at less than 1KB, our script will not add any bloat to your website or cause performance issues.

One of the ways we achieve that is by radically limiting the number of options in the default script. Instead, we provide separate script files based on how you might want to use Plausible.

For example, the default script.js script will automatically work with pushState based frontend routing which is the most common. If your website uses hash-based routing instead, you have the option of loading the script with a different extension: script.hash.js.

In this case, the snippet you need to insert into your site is as follows (make sure to change the data-domain attribute to the domain you added to Plausible):

<script defer data-domain="yourdomain.com" src="https://plausible.io/js/script.hash.js"></script>

Another example: If you want to track clicks on outbound links on your site, you can use the script.outbound-links.js extension.

In this case, the snippet you need to insert into your site is as follows:

<script defer data-domain="yourdomain.com" src="https://plausible.io/js/script.outbound-links.js"></script>

This approach makes sure that you only load the code that will actually be used on your website. Websites should not have to load dozens or hundreds of kilobytes of dead JavaScript code on every page load which degrades the user experience and causes unnecessary network traffic.

All our script extensions

Here's the list of all the available extensions at this time:

ExtensionExplanation
script.hash.jsAutomatically follow frontend navigation when using hash-based routing
script.outbound-links.jsAutomatically track clicks on outbound links from your website
script.file-downloads.jsAutomatically track file downloads
script.exclusions.jsExclude certain pages from being tracked
script.compat.jsCompatibility mode for tracking users on Internet Explorer
script.local.jsAllow analytics to track on localhost too which is useful in hybrid apps
script.manual.jsDo not trigger pageviews automatically. Also allows you to specify custom locations to redact URLs with identifiers. You can also use it to track custom query parameters

You can combine extensions according to your needs

If you want to use both our hash-based routing extension and our outbound link click extension, you can combine them as follows: script.hash.outbound-links.js.

In this case, the snippet you need to insert into your site is as follows (make sure to change the data-domain attribute to the domain you added to Plausible):

<script defer data-domain="yourdomain.com" src="https://plausible.io/js/script.hash.outbound-links.js"></script>

Or say you want to use our script.exclusions.js extension to exclude certain pages from being tracked and our script.local.js extension to track localhost traffic, your snippet should look like this:

<script defer data-domain="yourdomain.com" src="https://plausible.io/js/script.exclusions.local.js"></script>

You can mix and match, and combine extensions any way that you wish. And you only need to insert that one snippet into your site, no need for anything else.

script.compat.js

The default Plausible script will not work on Internet Explorer because it uses the document.currentScript API to read configuration options. You can run Plausible in compatibility mode by including the script.compat.js extension and defining id="plausible" on the script tag so that it can find itself. Here's how it should look like:

<script id="plausible" defer data-domain="yourdomain.com" src="https://plausible.io/js/script.compat.js"></script>

script.manual.js

By default, the Plausible script triggers a pageview when it is first loaded. It also attaches listeners to the History API and will automatically trigger pageviews when you use history.pushState. This is useful for most websites but we also offer a manual mode in case you want full control over when pageviews are triggered on your website.

One of the use-cases for this is when you use Turbo (formerly Turbolinks). In that case, you want to manually trigger Plausible pageviews on the turbo:load or turbolinks:load browser event depending which library you use. Here's how you can do that:

<script defer data-domain="yourdomain.com" src="https://plausible.io/js/script.manual.js"></script>
<!-- define the `plausible` function to manually trigger events -->
<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
<!-- trigger pageviews on turbolinks navigation -->
<script>
document.addEventListener("turbo:load", function() {
plausible('pageview')
})
</script>
note

When using turbolinks, make sure that the Plausible script isn't loaded and executed during turbo navigation. You may need to move the script to the <head> section of your website or use the data-turbo-eval="false" attribute.

Specify custom locations for your page URLs

Additionally, the manual script extension allows you to provide a special option named u with your events. This allows you to specify the URL of the page and can be used to specify custom locations.

It is especially helpful to redact and aggregate multiple pages whose URLs contain identifiers that are specific to users. Learn more about specifying custom URLs in your events.

Track custom query parameters for complete page URLs

By default, Plausible strips all query parameters for privacy purposes except ref, source, utm_source, utm_medium, utm_campaign, utm_content and utm_term.

This means that pages like yoursite.com/blog/index.php?article=some_article&page=11 will be reported as yoursite.com/blog/index.php in the Top Pages report of your Plausible dashboard.

By using the manual script extension, you can also track custom query parameters and get the complete page URLs in your Top Pages report. Learn here how to do that.