Analytics platforms integrations
How it works
We use existing analytics platforms integrations on your site. This means means that your site must implement the target analytics' platform JavaScript code to track analytics events.
Supported platforms
- Segment
- Mixpanel (see Platform's notes)
- Heap
- Customer.io
- HubSpot (see dedicated article here)
- Sessionstack
- Smartlook
- Google Analytics (see Platform's notes)
Custom platform
If you use another platform, you can use our JS API to forward events.
What events and data we send
This table shows the full overview of all the events and data that can be sent. Some platforms cannot work with some of the custom data shown below.
In case you use one of our native analytics integrations, Event name will be visible in the analytics platform. If you use our JS API to forward events, you will also get Raw name in the JavaScript object.
| Event name | Raw name | Data | Notes |
|---|---|---|---|
| Announcements Banner Action Consumed | announcements_banner_action_consumed | id | v2 announcements |
| Announcements Banner Dismissed | announcements_banner_dismissed | id | v2 announcements |
| Announcements Banner Opened | announcements_banner_opened | id | v2 announcements |
| Announcements Newsfeed Item Consumed | announcements_newsitem_action_consumed | id | v2 announcements |
| Announcements Popup Action Consumed | announcements_popup_action_consumed | id | v2 announcements |
| Announcements Popup Dismissed | announcements_popup_dismissed | id | v2 announcements |
| Announcements Popup Opened | announcements_popup_opened | id | v2 announcements |
| Announcements Popups Stack Dismissed | announcements_popup_stack_dimissed | ids | v2 announcements |
| Life Ring button - Announcements click | button_changelogs_click | ||
| Announcement open | changelog_loaded | A set of title_LNGCODE | |
| Checklist dismissed | checklist_dismissed | checklistId checklistName | |
| Checklist completed | checklist_done | checklistId checklistName | |
| Hint dismissed forever | context_help_dismissed | containerId cardId cardName | |
| Hint open | context_help_loaded | containerId cardId cardName | |
| Feedback sent | feedback_sent | videosCount screenshotsCount | |
| Mood gathered | mood_gathered | tourId tourName cardId cardName containerId rating tag | Sent when the user submits the adoption meter rating. Rating is sent as a number between 0 - 10. |
| Tour - Card step back | tour_card_back | tourId tourName cardId cardName currentCardOrder cardOrderWithName | Sent when a user returns to the previous step |
| Tour - Custom button clicked | tour_card_button_click | tourId tourName cardId cardName currentCardOrder cardOrderWithName buttonAction buttonTitle connectedTourId or url | |
| Tour - Card open | tour_card_loaded | tourId tourName cardId cardName currentCardOrder cardOrderWithName | Sent when the card is rendered to the user. |
| Tour - Card read | tour_card_read | tourId tourName cardId cardName durationMs durationS | Sent when the card is closed by the user. |
| Tour finished | tour_finished | tourId tourName cardId cardName | |
| Tour skipped | tour_skipped | tourId tourName cardId cardName | |
| Tour started | tour_started | tourName tourId forced | |
| Tour started (Life Ring button) | tour_started_from_button | tourId tourName | Sent if the tour is started from the Life Ring button. The Tour started event is also sent. |
| Life Ring button - Widget click | type (currently always 'link') url |
All events also have the pfVendorName property set to Product Fruits.
Platforms notes
Mixpanel
We call the window.mixpanel.track method. Multi-environment Mixpanel installations are not currently supported.
Note that if Mixpanel has been installed via the NPM package then you must make the window.mixpanel equal to mixpanel, as seen below:
window.mixpanel = mixpanel;
Google Analytics
For the integration to function properly, Google analytics must be installed in the application where Product Fruits is deployed.
To enable the integration, first select the Integrations menu option as seen in the image below. Here, select Google Analytics from the menu, and click Activate to enable the integration. After activation, verify the date Google Analytics is receiving data by checking the Realtime reports in your Google Analytics dashboard. Alternatively, you can use Tag Assistant, to ensure that events from the table above are being properly forwarded.
From a technical standpoint, we call window.ga('send', ...) or window.gtag('event', ...) methods. We don't currently support named installations.