Plausible Documentation

The Plausible Site provisioning API allows you to programmatically manage sites, which is ideal for agencies, SaaS platforms, or white-label deployments.

Key capabilities include:

• Site Management: List, create, update (e.g., change domain), and delete sites.
• Configuration: Configure tracker script settings.
• Shared Links: Find or create shared links for use with the embed dashboard functionality.
• Goals & Events: Manage goals (list, find/create by type and value, delete) and custom properties.
• Access Control: Manage site guests and invitations (list, create, delete).
• Discovery: Get site details by domain and list teams.

The Plausible Stats API is a single-endpoint HTTP interface designed to query both historical and real-time analytics data.

By sending a POST request to /api/v2/query with a JSON body, you can retrieve complex metrics and dimensions as JSON.

Note:

• If you want to record pageviews or custom events, use the Events API.
• If you want to manage site settings, use the Sites API.

Every new Plausible account includes a 30-day free trial. This trial provides full access to all features and limits of the Business plan, allowing you to test the complete product before committing to a paid subscription.

Key trial characteristics:

• No credit card required: You do not need to provide payment information during registration.
• No automatic charges: The trial will not automatically convert into a paid subscription. If you do nothing, the trial simply ends.
• Data retention: If you choose to upgrade to a paid plan after the trial ends, all stats collected during the trial period are preserved; nothing is reset.

Within Account Settings, you can manage the following categories:

Preferences

• Dashboard appearance: Configure whether the dashboard uses light, dark, or system-based themes.
• Email address: Update the email address used for logging into your account.

Security

• Two-factor authentication (2FA): Secure your account by adding a second login step via an authenticator app.
• Login management: View all currently active sessions and remotely terminate them.
• Password: Reset or change your account password.

Subscription and API keys

Note: If you are part of a team, these settings are managed in Team Settings instead of Account Settings.

• Subscription plans: View details of your current tier and what is included.
• Stats API keys: Create and manage keys required for accessing Plausible data via the Stats API.

In addition to form submissions, Plausible provides other automated tracking features that can be enabled in the Site Installation area of your site settings without code changes:

• Outbound link clicks: Tracks when users click links leading away from your site.
• File downloads: Tracks when users download files.
• 404 error pages: Can be tracked by adding a small code snippet to your site.

The Plausible dashboard provides a consolidated view of your essential website statistics. Key features include:

• Filters and Segments: Drill down into specific slices of your traffic.
• Compare Periods: Benchmark current stats against previous time ranges.
• Annotations: Mark specific events (like deployments or campaigns) directly on your charts.
• Real-time Dashboard: View a live feed of current visitors.
• Traffic Sources: Analyze channels, sources, and campaigns to see where traffic originates.
• Scroll Depth: Monitor how far visitors read down your pages.
• Google Search Console Integration: View search queries alongside your analytics.
• Data Studio Connector: Connect your data to Looker Studio for custom reporting.

The Consolidated View is a feature available on the Business plan that combines traffic from all sites within a Plausible team into a single dashboard. It provides a holistic overview of total visitors and key metrics across your entire network of domains, brands, or country variants.

Key Characteristics

• Automatic Inclusion: Any site added to your team is automatically included in the consolidated view. Removing a site automatically removes its data (including historical stats) from the view.
• No Setup Required: It requires no manual configuration or maintenance; it appears automatically on the Sites page if your team has at least two sites.
• Standard Dashboard Experience: It functions like a regular site dashboard but aggregates data from all properties.

A Bounce Rate is the percentage of visitors who leave your site without meaningful engagement.

By default, a visit is marked as a bounce unless the visitor:

1. Views more than one page.
2. Triggers a custom event.

Improving Bounce Rate for Single-Page Apps (SPAs): Since SPAs often don't trigger additional page loads, you should use custom events (e.g., button clicks, video plays) to signal engagement. Any custom event triggered removes the visitor from the bounce count.

Non-interactive Events: If you want to track an event for data purposes but do not want it to count as engagement (i.e., you still want the visitor to be counted as a bounce if they don't do anything else), mark the event as interactive: false.

plausible('Custom Event', {interactive: false})

The Stats API v1 is a legacy interface. It provides a read-only way to retrieve historical and real-time statistics via GET requests with query parameters.

Important: For new integrations, you should use the v2 API instead of v1.

• Use the Events API to send pageviews or custom events.
• Use the Sites API to manage your sites.
• Use the Stats API v2 for new statistical data integrations.