Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ description: "Common billing questions for Plausible Analytics. Pageview-based p
</head>

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

## Is the billing based per account or per website?

Expand Down Expand Up @@ -184,4 +185,8 @@ Ad blockers and privacy extensions can interfere with the payment form. Try disa

Have a billing question not covered here? [Contact us](https://plausible.io/contact).

Not yet subscribed? [Start a free trial](https://plausible.io/register). 30 days free, no credit card required.
<CtaBox
headline="Not yet subscribed? 30 days free, no credit card required"
link="https://plausible.io/register"
linkText="Start free trial"
/>
3 changes: 2 additions & 1 deletion docs/consolidated-views.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Plausible's Consolidated View combines traffic from all your sites
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

**Consolidated View is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="consolidated-views" plan="business" label="Consolidated View" />

If you have multiple websites in your Plausible account, the **Consolidated View** gives you an overview of traffic across all of them. This allows you to quickly see the total number of visitors and other key metrics across all your properties in one place.

Expand Down
7 changes: 7 additions & 0 deletions docs/custom-event-goals.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Track button clicks, signups and any custom action in Plausible us
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

:::note
If you use the custom events feature, then these count towards your billable monthly pageviews.
Expand All @@ -16,6 +17,12 @@ Custom events let you measure button clicks, subscription signups or any other a

If you're using WordPress or Google Tag Manager, you can set up custom events with our [WordPress plugin](https://plausible.io/wordpress-analytics-plugin) or [GTM template](https://plausible.io/gtm-template) without writing code. Plausible also offers automated tracking for [outbound link clicks](outbound-link-click-tracking.md), [file downloads](file-downloads-tracking.md) and [form submissions](form-submissions-tracking.md) straight from your site settings, [pageview goals](pageview-goals.md) for tracking visits to specific pages and [404 error pages](error-pages-tracking-404.md) with a small snippet of code.

<CtaBox
headline="Testing this workflow for your site? Custom events work during the free trial, no credit card required"
link="https://plausible.io/register"
linkText="Start free trial"
/>

## Add a CSS class name to the element you want to track on your site

Tag the site element you want to track with a CSS class name. How to do this varies depending on the site builder, CMS or framework you've used to build your site.
Expand Down
3 changes: 2 additions & 1 deletion docs/custom-props/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ description: "Custom properties in Plausible let you attach your own metadata to
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

Custom properties let you collect and analyze metrics that Plausible doesn't track automatically. You can attach them to pageviews or custom events to create your own segments and filters. If you're coming from Google Analytics, custom properties are equivalent to [custom dimensions](https://plausible.io/blog/custom-dimensions-analytics).

**Custom properties are a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="custom-properties" plan="business" label="Custom properties" />

For example, say you want to track your blog posts by `author`. Every time a visitor lands on one of the posts, you can send a pageview with the property `author=...`. You can then filter your Plausible dashboard by a specific author to see all the relevant stats for the posts published by that particular writer.

Expand Down
3 changes: 2 additions & 1 deletion docs/ecommerce-revenue-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ description: "Assign revenue values to custom events in Plausible to see which c
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

Track which marketing campaigns and landing pages drive the most revenue by assigning monetary values to your custom events.

**Revenue tracking is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="ecommerce-revenue-tracking" plan="business" label="Revenue tracking" />

When you create a new custom event, you can optionally assign a monetary value to it. Our revenue tracking supports multi-currencies too. You can send data in any local currency that the purchase is made in. When using revenue tracking, you'll be able to see these metrics in your dashboard:

Expand Down
7 changes: 7 additions & 0 deletions docs/embed-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ description: "Embed a Plausible analytics dashboard into your own site or produc
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

You can embed your Plausible stats dashboard into any other website using an HTML iframe. This is useful in case you want to showcase your stats on your own website or if you want to [offer Plausible-powered web analytics dashboard (without our branding)](https://plausible.io/white-label-web-analytics) directly in your user interface.

<CtaBox
headline="Offer clients a branded analytics dashboard powered by Plausible"
link="https://plausible.io/white-label-web-analytics"
linkText="White-label analytics"
/>

## 1. Create a shared link

You need to create a shared link to embed your dashboard into another website.
Expand Down
3 changes: 2 additions & 1 deletion docs/funnel-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ description: "Measure drop-off across multi-step conversion paths with Plausible
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

Define a sequence of steps and measure how many visitors complete each one. Use funnel analysis to find where people drop off and improve your conversion rate.

**Funnel analysis is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="funnel-analysis" plan="business" label="Funnel analysis" />

* You can go beyond pageviews and use any custom events to build a funnel
* Choose between two funnel types: sequential (visitors can take other actions between steps) or strict order (steps must happen in exact consecutive order)
Expand Down
9 changes: 9 additions & 0 deletions docs/google-analytics-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,20 @@ description: "Import your historical Google Analytics 4 data into Plausible Anal
</head>

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

Plausible Analytics allows you to import your historical stats from Google Analytics 4 (GA4). You can import multiple Google Analytics properties into the same Plausible dashboard without having any gaps in the data and without any double-counting. You can also segment the imported data and export it using our regular exporting methods ([CSV](export-stats.md) and [stats API](stats-api.md)).

Here's how you can import your historical Google Analytics stats into your Plausible dashboard.

<CtaBox
headline="Migrating from Google Analytics? Bring your historical data with you"
link="https://plausible.io/migrate-from-google-analytics"
linkText="Migration guide"
secondaryLink="https://plausible.io/register"
secondaryText="Start free trial"
/>

## How to import your historical stats from Google Analytics to Plausible Analytics

1. Go to the Plausible Analytics [site settings](website-settings.md) for the website you'd like to import the data for.
Expand Down
9 changes: 8 additions & 1 deletion docs/google-search-console-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,19 @@ description: "See Google Search Console keyword data inside Plausible Analytics.
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

In 2012, [Google stopped including](https://webmasters.googleblog.com/2012/03/upcoming-changes-in-googles-http.html) search terms in the `Referer` header when people click on a Google search. They only send Google as the referrer source instead. This means that Plausible can't automatically access search terms that lead users to your site.

However, you can still access your search terms by setting up your site on Google Search Console. Once you’ve done that, you can enable the Search Console integration in Plausible to get all your important search results stats under one roof.

This integration is privacy-friendly and requires no Google code to be placed on your site. Google is basically just sending us the information they've already collected on their search results.
This integration is privacy-friendly and requires no Google code to be placed on your site. Google is basically just sending us the information they’ve already collected on their search results.

<CtaBox
headline="See SEO queries and website analytics in one dashboard"
link="https://plausible.io/register"
linkText="Start free trial"
/>

Here’s how you can add your site to Search Console and then integrate the Search Console data into your Plausible dashboard:

Expand Down
7 changes: 7 additions & 0 deletions docs/integration-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ description: "Install Plausible Analytics on WordPress, Shopify, Webflow, Square
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

Installing Plausible on a website can be a slightly different process depending on what tools you're using to manage your site.

<CtaBox
headline="Don't have a Plausible account yet? Create one first, then follow the guide for your platform"
link="https://plausible.io/register"
linkText="Create free account"
/>

We've put together several guides that cover popular website builders and content management systems (CMS). These can help you set up and start counting your site visitors in no time. Thanks to the members of our community, there are also third-party integrations and plugins for various frameworks.

## Official integrations
Expand Down
10 changes: 10 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,18 @@ slug: /
description: "Plausible Analytics documentation. No cookies, no personal data, no consent banners. Get started with setup guides, dashboard explanations and feature references."
---

import CtaBox from '@site/src/components/CtaBox';

[Plausible Analytics](https://plausible.io/) is a simple, privacy-friendly alternative to Google Analytics. No cookies, no personal data collection, no consent banners required. One lightweight script, one easy-to-read dashboard. Running since 2018 and used by 18,000+ teams. Explore the [live demo](https://plausible.io/plausible.io) to see what it looks like.

<CtaBox
headline="Setting up Plausible for the first time? Start a free trial, then follow the guides below"
link="https://plausible.io/register"
linkText="Start free trial"
secondaryLink="https://plausible.io/plausible.io"
secondaryText="View live demo"
/>

<div class="docs-card-grid">

<div class="docs-card">
Expand Down
3 changes: 2 additions & 1 deletion docs/looker-studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ description: "Connect Plausible Analytics to Google Looker Studio using the offi
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

Plausible keeps its dashboard intentionally simple. For cases where you need more flexibility, such as custom client reports, branded dashboards or views that combine Plausible data with ad spend or CRM data, we have an official connector for Google Looker Studio (formerly Data Studio).

Looker Studio is Google's free data visualization tool. The Plausible connector lets you pull your analytics data directly into Looker Studio and build any report layout you need.

**Looker Studio connector is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="looker-studio" plan="business" label="Looker Studio connector" />

<div class="browser">
<img alt="Plausible Analytics Looker Studio template" src={useBaseUrl('img/plausible-looker-studio.png')} />
Expand Down
7 changes: 7 additions & 0 deletions docs/plausible-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: "Add the Plausible tracking snippet to your site's header. One ligh
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

To integrate your website with Plausible Analytics, you need to insert a Plausible tracking snippet into the header section of your site. Place the snippet within the `<head> … </head>` tags.

Expand All @@ -14,6 +15,12 @@ Click on the menu icon on the right-hand side of the site you'd like to get the

There you can also enable any [optional enhanced measurements](script-extensions.md).

<CtaBox
headline="Need your site-specific snippet? Add your site to Plausible first"
link="https://plausible.io/register"
linkText="Create free account"
/>

<div class="browser">
<img alt="Add script extensions and verify your installation" src={useBaseUrl('img/v2/add-script-extensions-verify-installation.webp')} />
</div>
Expand Down
10 changes: 10 additions & 0 deletions docs/proxy/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,20 @@ title: Bypass adblockers with a proxy
description: "Some adblockers block Plausible. A proxy routes analytics through your own domain to capture those visits. Choose between one-click, self-setup and managed options."
---

import CtaBox from '@site/src/components/CtaBox';

Some visitors use adblockers or privacy tools that block analytics scripts. Plausible is blocked far less than Google Analytics. Firefox and Safari do not block it by default, but some blocklist maintainers block all analytics regardless of privacy practices.

A proxy routes the Plausible script through your own domain as a first-party request, making it indistinguishable from your own files. This bypasses most blockers and lets you count visits that would otherwise be missed.

<CtaBox
headline="Need proxying without managing it yourself? Ask about the managed proxy option"
link="https://plausible.io/enterprise-web-analytics"
linkText="Enterprise plan"
secondaryLink="https://plausible.io/contact"
secondaryText="Contact us"
/>

## Which option fits you

### No proxy (default)
Expand Down
4 changes: 3 additions & 1 deletion docs/raw-data-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ title: Scheduled raw event exports
description: "Get event-level data from Plausible delivered automatically on a schedule. For data warehousing, compliance and internal analytics where aggregated stats are not enough."
---

**Scheduled raw event exports are an Enterprise plan feature.** [Contact us →](https://plausible.io/contact)
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

<PlanFeatureNote feature="raw-data-export" plan="enterprise" label="Scheduled raw event exports" />

The Stats API and CSV export give you aggregated data: totals, breakdowns and time series across your sites. For cases where you need the underlying event-level data, Plausible offers scheduled raw event exports.

Expand Down
3 changes: 2 additions & 1 deletion docs/sites-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ description: "Reference for the Plausible Sites API. Create, update and delete s
---

import {Required, Optional} from '../src/js/api-helpers.tsx';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

**Sites API is an Enterprise plan feature.** [Contact us →](https://plausible.io/contact)
<PlanFeatureNote feature="sites-api" plan="enterprise" label="Sites API" />

The Plausible Site provisioning API offers a way to create and manage sites in your Plausible account programmatically. This is useful if you run many websites or if you're [offering a web analytics dashboard powered by Plausible to your customers](https://plausible.io/white-label-web-analytics). The Site API allows these operations:

Expand Down
5 changes: 3 additions & 2 deletions docs/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ description: "How SSO works with Plausible Analytics. Supports SAML 2.0 and iden
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

<PlanFeatureNote feature="sso" plan="enterprise" label="SSO" />

Your team can sign in to Plausible Analytics using single sign-on (SSO). This removes the need for manual account creation, simplifies access management and gives you more control over who can log in.

SSO works by logging in through an identity provider (IdP). We support the SAML 2.0 protocol, which is compatible with most IdPs including Google Workspace, Okta and Microsoft Entra ID (Azure AD).

User accounts are provisioned just-in-time. As long as the IdP session is active and the email matches, users can log in to Plausible automatically.

SSO is available on our [Enterprise plan](https://plausible.io/enterprise-web-analytics). [Contact us](https://plausible.io/contact) to learn more.

:::tip What is SAML?
**Security Assertion Markup Language (SAML)** is an XML-based protocol for secure exchange of information between an authority (Identity Provider or IdP) and a consumer (Service Provider or SP - in this case, Plausible).
:::
Expand Down
7 changes: 3 additions & 4 deletions docs/stats-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ import { Required, Optional } from '../src/js/api-helpers.tsx';
import { getExampleCode, EXAMPLE_RESPONSE_META } from '../src/js/examples.tsx';
import CodeBlock from '@theme/CodeBlock';
import { SiteContextProvider } from '../src/js/sites.tsx';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

Plausible Stats API is a powerful single endpoint HTTP interface to **view historical and real-time stats**. In a nutshell, the endpoint `/api/v2/query` accepts both simple and complex stats queries in the POST request body and returns the metrics as JSON.

**Stats API is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)

[Try it now for your own site!](#examples)

:::tip[Not what you need?]
Take a look at our [Events API Reference](events-api.md) if you want to record pageviews or custom events for your sites, or [Sites API Reference](sites-api.md) if you want to manage your sites over the API.
:::

<PlanFeatureNote feature="stats-api" plan="business" label="Stats API" />

## Authentication

To create a new stats API key, log in to your Plausible Analytics account. In the top-right menu, click on your account name and go to settings.
Expand Down
13 changes: 8 additions & 5 deletions docs/subscription-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,17 @@ description: "Compare Plausible subscription plans. 30-day free trial, no credit
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import CtaBox from '@site/src/components/CtaBox';

Plausible gives you full control over your subscription. Choose a plan, pick monthly or yearly billing and upgrade or downgrade as your needs change. No long-term contracts.

[View plans and pricing →](https://plausible.io/#pricing) · [Start free trial →](https://plausible.io/register)
<CtaBox
headline="30-day free trial, no credit card required. Choose a plan when you're ready"
link="https://plausible.io/register"
linkText="Start free trial"
secondaryLink="https://plausible.io/#pricing"
secondaryText="View plans and pricing"
/>

## Which plan should I choose?

Expand Down Expand Up @@ -82,7 +89,3 @@ Everything is self-serve in your account settings:
- **[Download invoices](download-invoices.md)** - get invoices, add VAT numbers and change billing address.

Have a question? Check the [Billing FAQ](billing.md) or [contact us](https://plausible.io/contact).

---

**Not yet subscribed?** [Start a free trial](https://plausible.io/register). 30 days free, no credit card required. For enterprise needs, [contact us](https://plausible.io/contact).
3 changes: 2 additions & 1 deletion docs/user-journeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ description: "Explore the paths visitors take on your site. Start from any page
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import PlanFeatureNote from '@site/src/components/PlanFeatureNote';

The **Explore** tab lets you map the paths visitors actually take on your site. Pick any page, goal or event as a starting point and see what they did next. Or work backwards from a conversion to see what led visitors there.

**User journeys is a Business plan feature.** [Compare plans →](https://plausible.io/#pricing)
<PlanFeatureNote feature="user-journeys" plan="business" label="User journeys" />

* Works with your pages and events. No extra setup required.
* Pages from the same directory are automatically grouped to reduce noise and surface patterns more clearly
Expand Down
Loading
Loading