[DOCS DAY] added event tracking to v5 section (#2857)

* added event tracking to v5 section

* Add SEO docs and cleanup sidebar

* Fixes raw html in SSO docs

* fixed typo on sso page

Co-authored-by: Kim Gardner <kgardnr@gmail.com>
Co-authored-by: Vinh <vinh@vinh.tech>
This commit is contained in:
immber
2020-02-26 09:29:42 -08:00
committed by GitHub
parent c4801abfbe
commit 8d3de4b082
2 changed files with 34 additions and 0 deletions
+2
View File
@@ -110,6 +110,8 @@ sidebar:
url: /v5/integrating/counts/
- title: Moderating via Slack
url: /v5/integrating/slack/
- title: Event tracking
url: /v5/integrating/events/
- title: SEO & iframes
url: /v5/seo/
- title: API
+32
View File
@@ -0,0 +1,32 @@
---
title: Event Tracking
permalink: /v5/integrating/events/
---
The Coral embed script can emit events to the analytics tool of your choice. Common user actions, such as successfully posting a comment, posting a reaction, or changing a setting are all capturable with events.
## Analytics Tool Integration
To enable event tracking, modify your embed script to subscribe to the events hook. You will also need to add code to your page that sends the events to your analytics system. The particular way you send this will depend on what tool youre using. Refer to your tools API and docs to determine this.
In this example, were logging all events to the console as well as sending the `createComment.success` event.
```js
<script>
const CoralStreamEmbed = Coral.createStreamEmbed({
events: function(events) {
events.onAny(function(eventName, data) {
console.log(eventName, data);
if (eventName === 'createComment.success') {
my_event_tracker.send('createComment', data);
});
},
});
</script>
```
## Available Events
A complete list of trackable events is available on GitHub: https://github.com/coralproject/talk/blob/master/CLIENT_EVENTS.md