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
10 changes: 2 additions & 8 deletions docs/buttondown.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Newsletter signups won’t show up automatically in your Plausible dashboard. Yo

To configure a goal, go to your website’s settings in your Plausible Analytics account and visit the **Goals** section. You should see a prompt to add a goal.

<img alt="Add your first goal" src={useBaseUrl('img/goal-conversions.png')} />

Click on the **+ Add goal** button to go to the goal creation form.

Select `Custom event` as the goal trigger and enter this exact name: `Subscribe`.

<div class="browser">
<img alt="Add Subscribe goal" src={useBaseUrl('img/add-a-subscribe-goal.png')} />
</div>

Next, click on the **Add goal** button, and you’ll be taken back to the Goals page. After you've completed this process, all the newsletter signups will start being tracked and will be displayed in the **Goals** tab of your Plausible Analytics dashboard.

Expand All @@ -34,8 +34,6 @@ To configure a goal, go to your website’s settings in your Plausible Analytics

Select `Custom event` as the goal trigger and enter this exact name: `Outbound Link: Click`.

<img alt="Add Outbound Link Click goal" src={useBaseUrl('img/outbound-link-click-goal.png')} />

Next, click on the **Add goal** button to be taken back to the Goals page. After you've completed this process, all the external link clicks will start being tracked and will be displayed in the **Goals** tab of your Plausible Analytics dashboard.

You'll see **Outbound Link: Click** goal as soon as the first external link click has been tracked. That's all you need to do. Plausible will automatically record new external link clicks.
Expand All @@ -45,7 +43,3 @@ You'll see **Outbound Link: Click** goal as soon as the first external link clic
And that's it. You are now using Plausible Analytics to count your Buttondown archive stats including outbound link clicks and new subscribers.

Now you can go to your Buttondown site and verify whether Plausible Analytics script has been added and to your Plausible Analytics account to see whether the stats are being tracked. See here [how to verify the integration](troubleshoot-integration.md).

The stats will look like this:

<img alt="Plausible dashboard for your Buttondown newsletter" src={useBaseUrl('img/buttondown-dashboard.png')} />
12 changes: 10 additions & 2 deletions docs/carrd-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ We display your snippet during the process of adding a new site to your account.

* Go to the editor of your Carrd website and add an **Embed** component.

<div class="browser">
<img alt="Add embed element to Carrd" src={useBaseUrl('img/add-embed-element-to-carrd.png')} />
</div>

* In the element's settings make sure:

Expand All @@ -31,7 +33,9 @@ We display your snippet during the process of adding a new site to your account.

* Do click on the **Done** button and then **Publish** your changes. After you change the tracking snippet on your site, all the hash-based page paths on your Carrd website will start being tracked and will be displayed in the **Top Pages** tab of your Plausible Analytics dashboard.

<div class="browser">
<img alt="Add Plausible Analytics script to Carrd" src={useBaseUrl('img/add-plausible-script-to-carrd.png')} />
</div>

Now you can go to your Carrd website and verify that Plausible script has been added and to your Plausible account to see whether the stats are being tracked. See here [how to verify the integration](troubleshoot-integration.md).

Expand All @@ -53,7 +57,9 @@ If you're on a higher plan, like Pro Plus, you'll be able to set these IDs yours

To be sure of your element's ID, you can use your browser's dev tool to inspect the element.

<div class="browser">
<img alt="Confirm element ID in Carrd" src={useBaseUrl('img/confirm-element-id-carrd.png')} />
</div>

### 2. Trigger custom events with JavaScript on your site

Expand Down Expand Up @@ -83,7 +89,9 @@ Also do change the `classes` line to include the goal name in this format: `plau
</script>
```

<div class="browser">
<img alt="Modify Plausible script Carrd" src={useBaseUrl('img/modify-plausible-script-carrd.png')} />
</div>

Do click on the **Save Changes** button and then **Publish** your changes.

Expand All @@ -97,8 +105,6 @@ Click on the **+ Add goal** button to go to the goal creation form. Select `Cust

So in our example where we added a goal name `plausible-event-name=Button+Click` to the Carrd site, the goal to add in the Plausible account is `Button Click` (plus is replaced by a space).

<img alt="Add your custom event goal" src={useBaseUrl('img/button-click-custom-event-goal-carrd.png')} />

Next, click on the **Add goal** button and you'll be taken back to the Goals page.

### 4. Your goal should now be ready and tracking
Expand Down Expand Up @@ -133,7 +139,9 @@ If you want to trigger multiple custom events on the same site, you don't need t
</script>
```

<div class="browser">
<img alt="track multiple elements in Carrd" src={useBaseUrl('img/track-multiple-elements-carrd.png')} />
</div>

## What's next?

Expand Down
2 changes: 2 additions & 0 deletions docs/custom-automatic-link-tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ where `\/` stands for a forward slash (escaped with `\`) and `.*` will match any

You'll have to configure the goal for the click numbers to show up in your Plausible dashboard. To configure a goal, go to [your website's settings](website-settings.md) in your Plausible Analytics account and visit the **Goals** section. You should see an empty list with a prompt to add a goal.

<div class="browser">
<img alt="Add your first goal" src={useBaseUrl('img/goal-conversions.png')} />
</div>

Click on the **+ Add goal** button to go to the goal creation form.

Expand Down
14 changes: 9 additions & 5 deletions docs/get-started-with-postman.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,33 +12,37 @@ Postman is a simple interface that you can use for [our stats API](stats-api.md)

2) Go to **My Workspace** and then **Collections** to create a new collection. Feel free to give it a descriptive name such as **Plausible Stats API**.

<img alt="Create a new collection" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-1.png')} />

3) Once you've created the collection, you should have the authorization tab open in which you can select the Bearer Token type for authorization:

<div class="browser">
<img alt="Select the Bearer Token type for authorization" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-2.png')} />
</div>

4) In the Token field, you should paste your Plausible Stats API key. You can obtain the Stats API key for your account by going to [your Plausible account settings](https://plausible.io/settings).

5) Once that's done, go ahead and save the collection at the top right:

<div class="browser">
<img alt="Save the collection at the top right" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-3.png')} />
</div>

6) Then add a new request to this collection and again feel free to give it a descriptive name:

<img alt="Add a new request to this collection" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-4.png')} />
6) Then add a new request to this collection and again feel free to give it a descriptive name.

7) Now, you can copy an example query from [our stats API documentation](stats-api.md), and paste it into the request field as follows:

<div class="browser">
<img alt="Copy an example query from our documentation, and paste it" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-5.png')} />
</div>

This will automatically read the different parameters and display them at the bottom. You can modify the parameters from the URL and in the bottom section too.

8) Hit send and you should see the response. This should be formatted as JSON by default. You can choose some other formatting if you like.

9) Now, you probably want to export this data. For that, you can either download the response as a .json file (Save Response), or copy it to your clipboard:

<div class="browser">
<img alt="Download the response as a .json file (Save Response)" src={useBaseUrl('img/how-to-get-started-with-the-stats-api-using-postman-7.png')} />
</div>

10) To convert the data into the CSV format, you should copy the response to your clipboard, and paste it into a tool like [this one](https://www.convertcsv.com/json-to-csv.htm).

Expand Down
6 changes: 4 additions & 2 deletions docs/ghost-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,19 @@ In Ghost you can inject code across your entire site or on an individual post or

* In the **Menu**, click **Settings**, and then **Code Injection**.

<div class="browser">
<img alt="Ghost code injection" src={useBaseUrl('img/ghost-code-injection.png')} />
</div>

* Add your Plausible Analytics script to the **Site Header** text box. Code added into the **Site Header** field is injected into the `<head>` tag on every page of your site.

<img alt="Add Plausible script to Ghost" src={useBaseUrl('img/add-plausible-script-to-ghosts.png')} />

* After adding your code, click on the **Save** button.

Now you can go to your website and verify whether Plausible Analytics script has been added and to your Plausible Analytics account to see whether the stats are being tracked. See here [how to verify the integration](troubleshoot-integration.md).

<div class="browser">
<img alt="Ghost Portal flows" src={useBaseUrl('img/portal-ghost.png')} />
</div>

The Sign In/Sign up flows are part of Ghost's [Portal](https://ghost.org/help/setting-up-portal/) app and it's an unified experience for all Ghost sites. You cannot customize these flows by adding an ID or CSS class.

Expand Down
22 changes: 13 additions & 9 deletions docs/shopify-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Here's how to add Plausible Analytics to your Shopify store and set up the track

* Click on the icon with three dots next to your current theme and choose **Edit code** from the drop-down menu.

<div class="browser">
<img alt="Add Plausible to Shopify" src={useBaseUrl('img/add-custom-code-to-shopify.png')} />
</div>

* In the **Layout** folder, select your **theme.liquid** file and [paste your Plausible snippet](https://plausible.io/docs/plausible-script) in the **Head Code** section. We display your snippet during the process of adding a new site to your account. You can also see the snippet within the **Site Installation** area of the **General** section in your [site settings](website-settings.md).

<img alt="Add Plausible Analytics script to Shopify" src={useBaseUrl('img/add-plausible-script-to-shopify.png')} />

* Do click on the **Save Changes** to publish your changes.

## Track checkouts and revenue attribution
Expand All @@ -31,15 +31,19 @@ To create the custom pixel, follow these steps:
* Go to your Shopify admin page
* Click on the Settings button at the bottom left

<div class="browser">
<img alt="Shopify Settings" src={useBaseUrl('img/shopify-settings-revenue-metrics.png')} />
</div>

* Open the **Customer events** section, and click on **Add custom pixel**
* Choose a name for your pixel (e.g. **Plausible**)
* Copy and paste the snippet into the **Code** block according to your tracking needs [as instructed below](#snippet-options-for-the-custom-pixel)
* Click **Save** at the top, then connect the pixel
* That's it - your custom Plausible pixel should now be tracking!

<div class="browser">
<img alt="Shopify add pixel" src={useBaseUrl('img/shopify-add-pixel.png')} />
</div>

## Snippet options for the custom pixel

Expand Down Expand Up @@ -98,8 +102,6 @@ Doing this will segment your dashboard by the traffic that went through the chec

If you'd like to see these grouped order confirmations or checkout page visits permanently in your dashboard, you can add them as [pageview goals](pageview-goals.md).

<img alt="Shopify thank you page tracking" src={useBaseUrl('img/shopify-thank-you-page-goal.png')} />

### Track started checkouts

Send a custom event called **Begin Checkout** to Plausible every time the checkout process is started. The total price of the shopping cart will be recorded under this event.
Expand Down Expand Up @@ -270,7 +272,9 @@ Here's how you can track particular form submissions and button clicks on your S

Your form or button element should have an ID attribute assigned by default. You can find this ID by selecting the element you want to track (do make sure you select your form element and not just the "Submit" button) and clicking on the settings gear.

<div class="browser">
<img alt="Shopify form ID" src={useBaseUrl('img/shopify-form-id.png')} />
</div>

### 2. Trigger custom events with JavaScript on your site

Expand Down Expand Up @@ -304,8 +308,10 @@ To represent a space character in goal names, you can use a `+` sign. For exampl
</script>
```

<div class="browser">
<img alt="Modify Plausible script" src={useBaseUrl('img/modify-plausible-script-shopify.png')} />

</div>

Do click on the **Save** button to save your changes.

### 3. Create a custom event goal in your Plausible account
Expand All @@ -314,14 +320,10 @@ When you send custom events to Plausible, they won't show up in your dashboard a

To configure a goal, go to [your website's settings](website-settings.md) in your Plausible account and visit the **Goals** section. You should see an empty list with a prompt to add a goal.

<img alt="Add your first Shopify goal" src={useBaseUrl('img/add-goal-shopify.png')} />

Click on the **+ Add goal** button to go to the goal creation form. Select `Custom event` as the goal trigger and enter the name of the custom event you are triggering. The name must be an exact match to the one you added to your site for the conversions to show up in your dashboard.

So in our example where we added a goal name `plausible-event-name=Form+Submit` to the Shopify site, the goal to add in the Plausible account is `Form Submit` (plus is replaced by a space).

<img alt="Add your custom event goal" src={useBaseUrl('img/form-submission-custom-event-goal-shopify.png')} />

Next, click on the **Add goal** button and you'll be taken back to the Goals page.

### 4. Your goal should now be ready and tracking
Expand Down Expand Up @@ -356,7 +358,9 @@ If you want to trigger multiple custom events on the same site, you don't need t
</script>
```

<div class="browser">
<img alt="track multiple elements in Shopify" src={useBaseUrl('img/track-multiple-elements-shopify.png')} />
</div>
</details>

## What's next?
Expand Down
26 changes: 16 additions & 10 deletions docs/squarespace-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ Here's how to add Plausible Analytics to your Squarespace site

* [Paste your Plausible snippet](https://plausible.io/docs/plausible-script) in the **Header Code** section. We display your snippet during the process of adding a new site to your account. You can also see the snippet within the **Site Installation** area of the **General** section in your [site settings](website-settings.md).

<img alt="Add Plausible Analytics script to Squarespace" src={useBaseUrl('img/add-plausible-script-to-Squarespace.png')} />

* Do click on the **Save**
* Click on **Save**

Now you can go to your Squarespace website and verify that Plausible script has been added and to your Plausible account to see whether the stats are being tracked. See here [how to verify the integration](troubleshoot-integration.md).

Expand All @@ -30,33 +28,41 @@ The easiest way to track form submissions on your Squarespace site is to track t

* First you'll need to create a "thank you" page by clicking on the "Pages" panel and creating the page by clicking on the "+" button in the **Not Linked** section.

<div class="browser">
<img alt="Create the form submission thank you page in Squarespace" src={useBaseUrl('img/create-a-thank-you-page-in-Squarespace.png')} />
</div>

* Click on the gear icon button next to your "thank you" page to access the page's settings. Here you can see ( or edit ) the page path.

<div class="browser">
<img alt="Squarespace form submission thank you page path" src={useBaseUrl('img/squarespace-thank-you-page-path.png')} />
</div>

### 2. Set the redirect URL on form submission

* Go to the page that contains your form, and click on **Edit**. Now click on the form to select it and click on the pencil icon to edit it.

<div class="browser">
<img alt="Edit the form in Squarespace" src={useBaseUrl('img/Edit-form-squarespace.png')} />
</div>

* In the "Content" section, click on "Post-submit". Make sure you select the "Redirect" option and in the "Redirect URL" field type in the path to the thank you page ( i.e. **/thank-you** )
* In the "Content" section, click on "Post-submit". Make sure you select the "Redirect" option and in the "Redirect URL" field type in the path to the thank you page ( i.e. **/thank-you** ).

<div class="browser">
<img alt="Add redirect URL to your form in Squarespace" src={useBaseUrl('img/add-redirect-url-to-form-in-Squarespace.png')} />
</div>

### 3. Create a pageview goal in your Plausible account
<div class="browser">
<img alt="Add redirect URL to your form in Squarespace" src={useBaseUrl('img/redirect-url.png')} />
</div>

When you send custom events to Plausible, they won't show up in your dashboard automatically. You'll have to configure the goal for the conversion numbers to show up.
### 3. Create a pageview goal in your Plausible account

To configure a goal, go to [your website's settings](website-settings.md) in your Plausible account and visit the **Goals** section. You should see an empty list with a prompt to add a goal.

<img alt="Add your first Squarespace goal" src={useBaseUrl('img/add-goal-squarespace.png')} />

Click on the **+ Add goal** button to go to the goal creation form. Select `Pageview` as the goal trigger and enter the and enter the page path that you want to track ( i.e. **/thank-you**)
Click on the **+ Add goal** button to go to the goal creation form. Select `Pageview` as the goal trigger and enter the page path that you want to track ( i.e. **/thank-you**).

<img alt="Thank you pageview goal in Squarespace" src={useBaseUrl('img/thank-you-pageview-goal-squarespace.png')} />
[Here's more information](https://plausible.io/docs/pageview-goals) about creating pageview goals in your Plausible account.

### 4. Your goal should now be ready and tracking

Expand Down
Loading
Loading