Skip to content

WIP: Scriptv2 docs #614

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

Draft
wants to merge 32 commits into
base: master
Choose a base branch
from
Draft

WIP: Scriptv2 docs #614

wants to merge 32 commits into from

Conversation

macobo
Copy link
Contributor

@macobo macobo commented Jun 26, 2025

What's new:

  • Script update guide
  • Form submission tracking

What's updated:

  • Rewrite docs/script-extensions.md
  • Script feature description docs
  • docs/plausible-script.md
  • docs/troubleshoot-integration.md
  • Proxy documentation
  • Integrations documentation
    • docs/carrd-integration.md
    • docs/shopify-integration.md

TBD:

  • Images (onboarding, img/data-domain-plausible-analytics-script.png, static/img/network-check-if-plausible-is-working.png)
  • Google tag manager guide
  • NPM library references


After you disable 404 error pages tracking, we will automatically remove the goal called `404` from your site.
After you disable 404 error pages tracking, we will automatically remove the goal called `404` from your site.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving a note here: At the moment thinking is that 404 goal will have to be manually created


## Step 1: Enable "Outbound links" for your site
## Enable "Outbound links" for your site

You can enable "**Outbound links**" as an optional measurement when adding a new site to your Plausible account. If the site has already been added to your account, you can control what data is collected in the "**Site Installation**" area of the "**General**" section in your [site settings](website-settings.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: The docs should probably be re-written from the perspective that these goals are enabled by default


Click on a particular file URL to filter the dashboard by those clicks only and get the full overview of that specific file.

Want to group file downloads by the domain name or any other keyword? In the "**Filter**" button in the top right of your dashboard, choose "**Property**". Then select "**url**" (this includes all the file download URLs we have recorded) and use the "**contains**" option. Add whatever domain or keyword you want to group the file downloads by and click on the "**Apply Filter**" button.

## Which file types are tracked?

Our "**File downloads**" tracking captures a file download event each time a link is clicked with a document, presentation, text file, compressed file, video, audio or other common file type. Both internal and external files downloads are tracked. These file extensions are tracked by default:
Our "**File downloads**" tracking captures a file download event each time a link is clicked with a document, presentation, text file, compressed file, video, audio or other common file type. Both internal and external files downloads are tracked. These file extensions are tracked by default:

`.pdf`, `.xlsx`, `.docx`, `.txt`, `.rtf`, `.csv`, `.exe`, `.key`, `.pps`, `.ppt`, `.pptx`, `.7z`, `.pkg`, `.rar`, `.gz`, `.zip`, `.avi`, `.mov`, `.mp4`, `.mpeg`, `.wmv`, `.midi`, `.mp3`, `.wav`, `.wma`, `.dmg`

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Limitations
Clicks on download links within `svg` elements are not tracked.

@@ -65,6 +57,6 @@ Check out this blog post for more details on the value of [tracking outbound lin

You can control what data is collected in the "**Site Installation**" area of the "**General**" section in your [site settings](website-settings.md).

When making changes to your optional measurements, your snippet will change so do ensure to insert the newest snippet into your site for outbound link click tracking to stop.
When making changes to your optional measurements, your snippet will change so do ensure to insert the newest snippet into your site for outbound link click tracking to stop.

After you disable outbound link click tracking, we will automatically remove the goal called `Outbound Link: Click` from your site.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After you disable outbound link click tracking, we will automatically remove the goal called `Outbound Link: Click` from your site.
After you disable outbound link click tracking, we will automatically remove the goal called `Outbound Link: Click` from your site.
## Limitations
Clicks on outbound links within `svg` elements are not tracked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants