> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/plausible/analytics/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start Guide

> Get started with Plausible Analytics in 2 minutes. Add privacy-friendly analytics to your website and see your first pageview.

## Get Up and Running Fast

This guide will help you set up Plausible Analytics and start tracking your website traffic in just a few minutes. No complex configuration needed.

<Note>
  This quick start covers **Plausible Cloud**, our managed service. For self-hosting instructions, see the [Installation guide](/installation).
</Note>

## Prerequisites

All you need is:

* A website where you can add code to the `<head>` section
* 2 minutes of your time

No credit card required for the 30-day free trial.

## Step 1: Create Your Account

<Steps>
  <Step title="Sign Up">
    Visit [plausible.io/register](https://plausible.io/register) and create your account.

    Enter your email and create a password. You'll receive a confirmation email to verify your account.
  </Step>

  <Step title="Add Your Website">
    After signing in, you'll be prompted to add your first website.

    Enter your domain exactly as it appears in the browser (e.g., `mywebsite.com` or `blog.mywebsite.com`).

    <Warning>
      Use the domain without `http://` or `https://`. Just the domain name like `example.com`.
    </Warning>
  </Step>

  <Step title="Configure Timezone and Region">
    Select your timezone and reporting region. This determines how your daily/weekly/monthly reports are calculated.
  </Step>
</Steps>

## Step 2: Install the Tracking Script

Plausible offers multiple installation methods. Choose the one that works best for your setup.

### Method 1: Manual Script Installation (Recommended)

This is the simplest method for most websites.

<Steps>
  <Step title="Copy Your Snippet">
    After adding your site, you'll see your unique tracking snippet that looks like this:

    ```html theme={null}
    <!-- Privacy-friendly analytics by Plausible -->
    <script async src="https://plausible.io/js/YOUR-SCRIPT-ID.js"></script>
    <script>
      window.plausible=window.plausible||function(){(plausible.q=plausible.q||[]).push(arguments)},plausible.init=plausible.init||function(i){plausible.o=i||};
      plausible.init()
    </script>
    ```

    <Note>
      Your actual snippet will include a unique Script ID specific to your site. The script is lightweight (\< 1KB) and won't slow down your website.
    </Note>
  </Step>

  <Step title="Add to Your Website">
    Paste the snippet into the `<head>` section of your website, before the closing `</head>` tag.

    For static sites, add it to your HTML template:

    ```html theme={null}
    <!DOCTYPE html>
    <html>
      <head>
        <title>My Website</title>
        
        <!-- Privacy-friendly analytics by Plausible -->
        <script async src="https://plausible.io/js/YOUR-SCRIPT-ID.js"></script>
        <script>
          window.plausible=window.plausible||function(){(plausible.q=plausible.q||[]).push(arguments)},plausible.init=plausible.init||function(i){plausible.o=i||};
          plausible.init()
        </script>
      </head>
      <body>
        <!-- Your content -->
      </body>
    </html>
    ```
  </Step>

  <Step title="Deploy Your Changes">
    Save the file and deploy your updated website.
  </Step>
</Steps>

### Method 2: WordPress Plugin

If you're using WordPress, we have an official plugin.

<Steps>
  <Step title="Install the Plugin">
    Go to your WordPress admin panel → Plugins → Add New

    Search for "Plausible Analytics" and click Install, then Activate.
  </Step>

  <Step title="Configure the Plugin">
    Go to Settings → Plausible Analytics

    Enter your domain and save the settings. The plugin will automatically add the tracking script to your site.
  </Step>
</Steps>

### Method 3: NPM Package

For modern JavaScript applications (React, Vue, Next.js, etc.):

<Steps>
  <Step title="Install the Package">
    ```bash theme={null}
    npm install @plausible-analytics/tracker
    ```
  </Step>

  <Step title="Initialize in Your App">
    ```javascript theme={null}
    import { init } from '@plausible-analytics/tracker'

    init({
      domain: 'mywebsite.com'
    })
    ```

    <Note>
      The `init` function must be called on the client side only. For SSR frameworks like Next.js, ensure initialization happens in a client component or `useEffect` hook.
    </Note>
  </Step>

  <Step title="Enable Auto-Capture (Optional)">
    By default, the NPM package automatically tracks pageviews. For SPA routing:

    ```javascript theme={null}
    init({
      domain: 'mywebsite.com',
      autoCapturePageviews: true  // enabled by default
    })
    ```
  </Step>
</Steps>

## Step 3: Verify Installation

<Steps>
  <Step title="Click Verify Installation">
    After adding the script, return to your Plausible dashboard and click the "Verify Installation" button.

    Plausible will automatically detect if the script is installed correctly on your site.
  </Step>

  <Step title="Visit Your Website">
    Open your website in a browser (in a regular window, not incognito mode).

    Navigate to a few pages to generate some test traffic.
  </Step>

  <Step title="Check Your Dashboard">
    Return to your Plausible dashboard. You should see your first pageview appear within a few seconds!

    <Note>
      The dashboard updates in realtime. If you don't see data immediately, wait 10-15 seconds and refresh.
    </Note>
  </Step>
</Steps>

## Step 4: Explore Your Dashboard

Congratulations! You're now tracking privacy-friendly analytics. Here's what you'll see:

<CardGroup cols={2}>
  <Card title="Current Visitors" icon="users">
    See how many people are on your site right now in realtime
  </Card>

  <Card title="Pageviews" icon="chart-line">
    Total pageviews over your selected time period
  </Card>

  <Card title="Top Pages" icon="file">
    Which pages on your site are getting the most traffic
  </Card>

  <Card title="Traffic Sources" icon="arrow-right-to-bracket">
    Where your visitors are coming from (Google, social media, direct, etc.)
  </Card>
</CardGroup>

## Optional: Enhanced Tracking

Want to track more than pageviews? Enable these optional features:

### Track Outbound Links

Automatically track when users click external links:

```javascript theme={null}
// NPM package
init({
  domain: 'mywebsite.com',
  outboundLinks: true
})
```

For the script installation, enable this option in your site settings.

### Track File Downloads

Monitor when users download files:

```javascript theme={null}
// NPM package
init({
  domain: 'mywebsite.com',
  fileDownloads: true
})
```

### Track Custom Events

Track button clicks, form submissions, and other user actions:

```javascript theme={null}
import { track } from '@plausible-analytics/tracker'

// Track a signup
track('Signup', { props: { plan: 'Pro' } })

// Track a purchase with revenue
track('Purchase', { 
  revenue: { amount: 29.99, currency: 'USD' },
  props: { product: 'Premium Plan' }
})
```

<Warning>
  Custom events and enhanced tracking features count towards your billable pageviews.
</Warning>

## Troubleshooting

<AccordionGroup>
  <Accordion title="I don't see any data in my dashboard">
    * Make sure you visited your site in a regular browser window (not incognito/private mode)
    * Check that the script snippet is in the `<head>` section, not the `<body>`
    * Verify your domain in the snippet matches exactly what you entered in settings
    * Disable any ad blockers and try again (note: Plausible is blocked by many ad blockers)
    * Check your browser console for any JavaScript errors
  </Accordion>

  <Accordion title="The script is installed but not detected">
    * Clear your browser cache and hard reload the page (Ctrl+Shift+R or Cmd+Shift+R)
    * Make sure the script loads before the closing `</head>` tag
    * Check that your Script ID is correct in the snippet
    * Some content security policies (CSP) may block the script - add plausible.io to your allowed domains
  </Accordion>

  <Accordion title="Pageviews aren't tracking on my SPA">
    If you're using a single-page application with client-side routing:

    * For NPM: ensure `autoCapturePageviews: true` is set (default)
    * For hash-based routing (/#/page), enable the hash routing option:
      ```javascript theme={null}
      init({
        domain: 'mywebsite.com',
        hashBasedRouting: true
      })
      ```
  </Accordion>

  <Accordion title="I want to exclude my own visits">
    Set `localStorage.plausible_ignore` to `"true"` in your browser console:

    ```javascript theme={null}
    localStorage.plausible_ignore = "true"
    ```

    Or add this to your site for a permanent exclusion link for you and your team.
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Set Up Goals" icon="bullseye">
    Track conversions like signups, purchases, or downloads
  </Card>

  <Card title="Invite Team Members" icon="user-plus">
    Collaborate with your team and assign roles
  </Card>

  <Card title="Email Reports" icon="envelope">
    Get weekly or monthly analytics reports sent to your inbox
  </Card>

  <Card title="Integrate Search Console" icon="magnifying-glass">
    See which keywords bring traffic from Google
  </Card>
</CardGroup>

<Note>
  Need help? Join our [community forum](https://github.com/plausible/analytics/discussions) or check the full [documentation](https://plausible.io/docs) for detailed guides.
</Note>
