Merge pull request #601 from plausible/non-interactive-events

Documentation for non-interactive custom events

Author: macobo

docs/custom-props/for-custom-events.md

@@ -56,4 +56,10 @@ All you have to do is add the second argument to this function call with the cus
 plausible('Download', {props: {method: 'HTTP', position: 'footer'}})
 ```
 
+To mark an event as non-interactive, you can set the `interactive` argument to `false`. This will exclude the event from bounce rate calculations.
+
+```js
+plausible('Custom Event', {interactive: false})
+```
+
 </details>

docs/events-api.md

@@ -144,6 +144,12 @@ For example, to track a purchase of US$ 1.322,22, your request body might look l
 ```
 <hr / >
 
+**interactive** <Optional />
+
+Whether the event is interactive. By default, Plausible will assume all events are interactive and will be counted for bounce detection.
+
+By marking a custom event as non-interactive, it will not be counted towards bounce rate calculationsp.
+
 ### Debugging
 
 By default, the API returns HTTP 202 Accepted. However, if you want to debug a request and see if the `X-Forwarded-For` header is set correctly, you can add the `X-Debug-Request` header to your request. If set to `true`, the API will return an HTTP 200 OK and the IP address which we will use for unique visitor counting.

docs/metrics-definitions.md

@@ -16,7 +16,7 @@ The average revenue of orders tracked. This is a part of the [revenue attributio
 
 The percentage of visitors with a single page view. A visitor "bounces" away and leaves your site after only viewing a single page.
 
-If you have issues with high bounce rates on your site, you can try to set up some [custom events](custom-event-goals.md). All custom events are considered interactive so any clicks on those events will count towards the bounce rate.
+If you have issues with high bounce rates on your site, you can try to set up some [custom events](custom-event-goals.md). Custom events are by default considered interactive and will count towards the bounce rate.
 
 ## Browser