diff --git a/docs/data-access.md b/docs/data-access.md index 37cd95c4..7ed4dcf1 100644 --- a/docs/data-access.md +++ b/docs/data-access.md @@ -15,7 +15,7 @@ Plausible gives you several ways to access your stats outside the dashboard. The | Create and manage sites programmatically | [Sites API](#sites-api) | | Embed analytics into my own product for my customers | [White-label integration guide](white-label.md) | | Download stats as a spreadsheet, one-off | [CSV export](#csv-export) | -| Build a custom report in Google's visualization tool | [Data Studio](#looker-studio) | +| Build a custom report in Google's visualization tool | [Data Studio](#data-studio) | | Pipe data into a data warehouse or BI tool | [Warehouse connectors](#data-warehouse-connectors) | | Get event-level data for warehousing or compliance | [Scheduled raw exports](#scheduled-raw-event-exports) | | Query data in natural language through AI tools | [MCP server](#mcp-server) | diff --git a/docs/embed-dashboard.md b/docs/embed-dashboard.md index b58d5f17..261f61f2 100644 --- a/docs/embed-dashboard.md +++ b/docs/embed-dashboard.md @@ -1,7 +1,7 @@ --- title: Embed the dashboard without our branding into your user interface sidebar_label: Embed the dashboard -description: "Embed a Plausible analytics dashboard into your own site or product using an iframe. Unbranded, scoped to a segment and requires no Plausible account to view." +description: "Embed a Plausible analytics dashboard into your own site or product using an iframe. Unbranded, scoped to one site or segment and requires no Plausible account to view." --- import useBaseUrl from '@docusaurus/useBaseUrl'; @@ -24,7 +24,7 @@ Want your embed to be limited to only include the stats of a specific segment of See our [shared link docs](shared-links.md) to see how. :::info Make sure to keep the password field blank -It's technically not possible to embed a password-protected dashboard. When you try to embed a password-protected dashboard, the browser will show a "refused to connect" error message. +It's technically not possible to embed a password-protected dashboard. The browser will show a "refused to connect" error message, so protect access through the application where you place the embed. ::: ## 2. Generate the embed code diff --git a/docs/looker-studio.md b/docs/looker-studio.md index 76b0339c..1a31ed25 100644 --- a/docs/looker-studio.md +++ b/docs/looker-studio.md @@ -9,7 +9,7 @@ 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 Data Studio. -Data Studio is Google's free data visualization tool. The Plausible connector lets you pull your analytics data directly into Data Studio and build any report layout you need. +Google Data Studio, formerly called Looker Studio, is Google's free data visualization tool. The Plausible connector lets you pull your analytics data directly into Data Studio and build a report around your needs. @@ -19,7 +19,7 @@ Data Studio is Google's free data visualization tool. The Plausible connector le ## Connect to Data Studio -Connecting your Plausible Analytics account to Data Studio is simple and can be done in a matter of minutes. First, you select our connector as a new data source in Data Studio. Our connector is called Plausible Analytics and it is made by us (Plausible Analytics). You can find our connector in the Data Studio public gallery, the in-product gallery or by visiting on [this direct link](https://lookerstudio.google.com/datasources/create?connectorId=AKfycbz88iSK4B6V-VoaiwocFu2dDp3CBRM0arAZoDjQ97SroAt9RtzgS6z3UCxpjJDi0ieVjQ). +Add the Plausible Analytics connector as a new data source in Data Studio. It appears in the public and in-product connector galleries with Plausible Analytics listed as the developer. You can also [open the connector directly](https://datastudio.google.com/datasources/create?connectorId=AKfycbz88iSK4B6V-VoaiwocFu2dDp3CBRM0arAZoDjQ97SroAt9RtzgS6z3UCxpjJDi0ieVjQ). Once you have selected the data source, you will be prompted to authorize the connector to access your Google account. @@ -53,9 +53,9 @@ You can select one or more of your Plausible sites to create a custom report. Si At this stage, you can check **Allow "Plausible Site(s)" to be modified in reports**. This default option in Data Studio lets you add a dropdown in your report to switch between your Plausible sites. If you don’t check it, you won’t have this feature. -You also have the ability to choose whether or not you want to constantly pull data in real-time by checking the **Data Refreshed in Real-time** box. Data Studio doesn’t refresh automatically, so this option ensures it fetches fresh data whenever you make changes to your report, like reordering tables or adding metrics. +Check the **Data Refreshed in Real-time** box to bypass the connector's six-hour cache and fetch current data for report queries. -If this box is not checked, the connector will by default cache data for 6 hours. This will make your reports quicker and will limit the number of API requests used by the connector which for most Plausible plans are limited to 600 per hour. If you have special needs for more API requests per hour, please [contact us](https://plausible.io/contact) to request more capacity. +If this box is not checked, the connector caches data for six hours. This makes reports quicker and limits the number of API requests. Stats API keys are limited to 600 requests per hour by default. If you need more capacity, please [contact us](https://plausible.io/contact). Once these options are configured, you can click **Connect** and you will see a list of all available fields for data and metrics that you can pull from Plausible. @@ -69,6 +69,29 @@ Finally, you can either click on **Create Report** or **Explore** to begin using That's it! You're ready to start creating your custom reports using the Plausible Analytics data. -You can explore this [simple report](https://lookerstudio.google.com/s/gm8gS_IpBiQ) and this [advanced report](https://lookerstudio.google.com/s/ltrWC2jaK4Q) that we’ve created in Data Studio which you can use as a template to start building your own custom reports. +You can explore this [simple report](https://datastudio.google.com/s/gm8gS_IpBiQ) and this [advanced report](https://datastudio.google.com/s/ltrWC2jaK4Q) that we’ve created in Data Studio which you can use as a template to start building your own custom reports. If you need some help on how to use Data Studio, take a look at [our Data Studio beginner's guide](https://plausible.io/blog/google-looker-studio-guide). + +## Working with goals and custom properties + +Your goal data comes through the **Goal Name** dimension. Use the **Events** metric for total conversions, the **Visitors** metric for unique conversions and the **Conversion Rate** metric for the conversion rate. Conversion Rate requires Goal Name to be added as a dimension or used in a filter. You can add a custom property field alongside it to filter or break down those conversions. + +Your custom properties come through two fields: **Custom Prop** (the property name, for example `url`) and **Custom Prop Value** (the values recorded for it). + +:::note +To make a custom property visible in the Plausible dashboard, add it for your site under **Site Settings** > **Custom Properties**. See [how to configure custom properties](custom-props/props-dashboard.md). +::: + +For example, to build a table that lists each downloaded file with its number of downloads (using [file downloads tracking](file-downloads-tracking.md), which records the file URL in the `url` property): + +* Dimension: **Custom Prop Value** +* Metric: **Events** (add **Visitors** too if you want unique downloaders) +* Filter: **Custom Prop** equals **url** +* Filter: **Goal Name** equals **File Download** + +## Troubleshooting + +**A report shows null values or an error.** Check your combination of dimensions and metrics. Session metrics such as Bounce Rate, Views per Visit and Visit Duration cannot be combined with event dimensions such as Goal Name or Custom Prop. If a combination returns null values or an error, use the Visitors metric instead or move the dimension into a filter. [Our Data Studio guide](https://plausible.io/blog/google-looker-studio-guide) covers these combinations with examples. + +**A newly configured custom property or goal doesn't show up.** Unless you've checked the **Data Refreshed in Real-time** box, the connector caches data for up to 6 hours, so new values can take that long to appear in your report. If you need them immediately, edit the connection and enable real-time refresh. Refreshing fields only updates the data source schema, not the values in your report. diff --git a/docs/white-label.md b/docs/white-label.md index 2a2e137a..5fa9748d 100644 --- a/docs/white-label.md +++ b/docs/white-label.md @@ -7,7 +7,7 @@ description: "Step-by-step guide to embedding Plausible analytics into your own import useBaseUrl from '@docusaurus/useBaseUrl'; import CtaBox from '@site/src/components/CtaBox'; -This guide is for teams embedding Plausible into their own product: SaaS platforms that want to give their users an analytics dashboard, agencies building client portals, or any product where analytics is a feature rather than an internal tool. +This guide is for teams embedding Plausible into their own product: SaaS platforms that want to give their users an analytics dashboard, agencies building client portals or any product where analytics is a feature rather than an internal tool.