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
2 changes: 1 addition & 1 deletion docs/google-analytics-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Google Analytics aggregates UTM source under the **source** dimension and they d

### Goals

It's possible to import your goal conversion data from Google Analytics 4. When your import finishes, you will not see your goal data show up automatically. You need to go to your site settings and [add the goals you want to show up on your dashboard](custom-event-goals.md#3-create-a-custom-event-goal-in-your-plausible-account). Note that ecommerce revenue numbers cannot be imported.
It's possible to import your goal conversion data from Google Analytics 4. When your import finishes, you will not see your goal data show up automatically. You need to go to your site settings and [add the goals you want to show up on your dashboard](custom-event-goals.md#create-a-custom-event-goal-in-your-plausible-account). Note that ecommerce revenue numbers cannot be imported.

### Browser versions

Expand Down
14 changes: 7 additions & 7 deletions docs/shopify-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ analytics.subscribe('checkout_started', async (event) => {

In order to see this information on your Plausible dashboard, you should:

* [Set up a revenue goal](ecommerce-revenue-tracking#step-3-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Begin Checkout` with your desired reporting currency
* [Set up a revenue goal](ecommerce-revenue-tracking#step-1-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Begin Checkout` with your desired reporting currency

### Track payment info added during checkout

Expand All @@ -139,7 +139,7 @@ analytics.subscribe('payment_info_submitted', async (event) => {

In order to see this information on your Plausible dashboard, you should:

* [Set up a revenue goal](ecommerce-revenue-tracking#step-3-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Add Payment Info` with your desired reporting currency
* [Set up a revenue goal](ecommerce-revenue-tracking#step-1-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Add Payment Info` with your desired reporting currency

### Track completed checkouts (purchases)

Expand All @@ -160,7 +160,7 @@ analytics.subscribe('checkout_completed', async (event) => {

In order to see this information on your Plausible dashboard, you should:

* [Set up a revenue goal](ecommerce-revenue-tracking#step-3-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Purchase` with your desired reporting currency
* [Set up a revenue goal](ecommerce-revenue-tracking#step-1-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Purchase` with your desired reporting currency

### Track "Add to Cart"

Expand Down Expand Up @@ -189,7 +189,7 @@ analytics.subscribe('product_added_to_cart', async (event) => {

In order to see this information on your Plausible dashboard, you should:

1. [Set up a revenue goal](ecommerce-revenue-tracking#step-3-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Add to Cart` with your desired reporting currency
1. [Set up a revenue goal](ecommerce-revenue-tracking#step-1-add-a-new-custom-event-and-specify-the-currency-of-your-choice) called `Add to Cart` with your desired reporting currency
2. [Set up two custom properties](/custom-props/props-dashboard#1-configure-custom-properties-in-your-site-settings) called `productTitle`, and `quantity`

### Track site searches
Expand All @@ -208,7 +208,7 @@ analytics.subscribe('search_submitted', async (event) => {

In order to see this information on your Plausible dashboard, you should:

1. [Set up a custom event goal](/custom-event-goals#step-4-create-a-custom-event-goal-in-your-plausible-account) called `Search`
1. [Set up a custom event goal](/custom-event-goals#create-a-custom-event-goal-in-your-plausible-account) called `Search`
2. [Set up a custom property](/custom-props/props-dashboard#1-configure-custom-properties-in-your-site-settings) called `searchQuery`

### Customize your own tracking pixel
Expand Down Expand Up @@ -248,10 +248,10 @@ This function sends events to Plausible. It is initialized within the setup bloc

The `plausible` function takes two arguments:

1. an event name which can be whatever you like - just make sure to [set up a goal](/custom-event-goals#step-4-create-a-custom-event-goal-in-your-plausible-account) with the same name to see it on your dashboard.
1. an event name which can be whatever you like - just make sure to [set up a goal](/custom-event-goals#create-a-custom-event-goal-in-your-plausible-account) with the same name to see it on your dashboard.
2. an object where a few options can be passed:

* [Object] `revenue` - allows you to attribute a monetary value to your Plausible event. The object needs to contain two keys: `amount` and `currency`. Note that you can only attribute a single monetary value to one event. The revenue option is ignored until you've [set up a revenue goal](ecommerce-revenue-tracking#step-3-add-a-new-custom-event-and-specify-the-currency-of-your-choice) in your Plausible dashboard. That's because currency conversion into your desired reporting currency happens at the time of receiving the event.
* [Object] `revenue` - allows you to attribute a monetary value to your Plausible event. The object needs to contain two keys: `amount` and `currency`. Note that you can only attribute a single monetary value to one event. The revenue option is ignored until you've [set up a revenue goal](ecommerce-revenue-tracking#step-1-add-a-new-custom-event-and-specify-the-currency-of-your-choice) in your Plausible dashboard. That's because currency conversion into your desired reporting currency happens at the time of receiving the event.
* [Object] `props` - here you can pass any value under any key you'd like. The key you choose will become the name of the custom property that you need to [configure in your site settings](/custom-props/props-dashboard#1-configure-custom-properties-in-your-site-settings). Note that you are responsible for ensuring that no [personally identifiable information](/custom-props/introduction#personally-identifiable-information) is tracked.
* [String] `u` - this field stands for the `url` of the page where this customer event happened. You will most likely want to just keep it the same as in the example. It's important to always pass this option because otherwise the url will become the location of the pixel which has nothing to do with the real location where the event happened.

Expand Down
8 changes: 4 additions & 4 deletions docs/stats-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ It's useful to be able to group data by time, which can be done via the followin

Note that:
- `time` dimensions are not usable in filters. Set [`date_range`](#date_range) instead.
- If no data falls into a given time bucket, no values are returned. [See `include.time_labels` option](#time-labels) for a workaround.
- If no data falls into a given time bucket, no values are returned. [See `include.time_labels` option](#include.time_labels) for a workaround.
- These dates and timestamps are reported in sites Reporting Timezone.

[See example](#example-timeseries)
Expand Down Expand Up @@ -288,7 +288,7 @@ When not specified, the default ordering is:

[See full query example](#example-custom-properties)

### include <Optional />
### include <Optional /> {#include}

Default: `{}`

Expand All @@ -298,7 +298,7 @@ Additional options for the query as to what data to include.

Default: `false`

If true, tries to include imported data in the result. See [imported stats](#imported-stats) for more details, [query example](#example-imports).
If true, tries to include imported data in the result. See [imported stats](#include.imports) for more details, [query example](#example-imports).

<details>
<summary>Read more on limitations of including imported data</summary>
Expand Down Expand Up @@ -344,7 +344,7 @@ rows for this query.

[See example](#example-pagination)

### pagination <Optional />
### pagination <Optional /> {#pagination}

Default: `{ "limit": 10000, "offset: 0 }`

Expand Down
Loading