mirror of
https://github.com/wassname/talk.git
synced 2026-07-13 17:45:56 +08:00
[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:
@@ -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
|
||||
|
||||
@@ -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 you’re using. Refer to your tool’s API and docs to determine this.
|
||||
|
||||
In this example, we’re 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
|
||||
Reference in New Issue
Block a user