Skip to content

Commit 596863d

Browse files
author
markzegarelli
authored
Merge pull request #3137 from Maguna/patch-1
Update Hotjar destination docs
2 parents 9d9a091 + 49addbf commit 596863d

File tree

1 file changed

+31
-19
lines changed
  • src/connections/destinations/catalog/hotjar

1 file changed

+31
-19
lines changed

src/connections/destinations/catalog/hotjar/index.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,36 @@ title: Hotjar Destination
33
rewrite: true
44
id: 5913371070a3e552b9561a4e
55
---
6-
[Hotjar](https://help.hotjar.com/hc/en-us) is the fast & visual way to understand your users. It offers a full set of user experience tools: heatmaps, session recordings, forms reporting, funnels, and feedback tools, giving you everything your team needs to uncover user insights and make the right changes.
6+
[Hotjar](https://hotjar.com){:target="_blank"} enables you to understand your users in a fast and visual way. Hotjar offers a full set of tools such as analytics, page heatmaps, session recordings, feedback tools, and more. Hotjar provides you with everything your team needs to uncover user insights and make the right product changes.
77

8-
The Segment Hotjar Destination allows you to both easily install Hotjar on your pages, and send [User Attributes](https://help.hotjar.com/hc/en-us/articles/360038394053-How-to-Setup-User-Attributes-in-4-Steps) information over Hotjar's [Identify API](https://help.hotjar.com/hc/en-us/articles/360033640653) using the Segment Identify Spec. As of February 3rd, 2020, this allows you to:
9-
10-
* [Target Polls and Incoming Feedback to users based on their User Attributes](https://help.hotjar.com/hc/en-us/articles/360022688554)
11-
* [Lookup and Delete user data based on their User ID](https://help.hotjar.com/hc/en-us/articles/360001749014)
12-
13-
In time, most or all Hotjar features will use User Attributes in some way, with filtering Recordings planned in the first half of 2020.
14-
15-
This destination is maintained by Segment.
8+
The Segment Hotjar Destination allows you to get started with Hotjar and its core APIs. You can:
9+
1. Automatically install the [Hotjar Tracking Code](https://help.hotjar.com/hc/en-us/articles/115011639927){:target="_blank"}.
10+
2. Automatically send [user attributes](https://help.hotjar.com/hc/en-us/articles/360033640653-Identify-API-Reference){:target="_blank"} to Hotjar by connecting your Segment `identify` calls with Hotjar's own Identify API.
11+
3. Automatically send [custom events](https://help.hotjar.com/hc/en-us/articles/4405109971095-Events-API-Reference){:target="_blank"} to Hotjar by connecting your Segment `track` calls with Hotjar's own Events API.
1612

13+
Knowing who your users are and what they're doing unlocks more advanced filtering and targeting capabilities across all of Hotjar's tools, helping you find meaningful insights faster.
1714

1815
## Getting Started
1916

2017
{% include content/connection-modes.md %}
2118

22-
1. From the Segment web app, click **Catalog**.
19+
1. Navigate to **Connections** and click **Add Destination** From the Segment web app.
2320

24-
2. Search for "Hotjar" in the Catalog, select it, and choose which of your Javascript sources to connect the destination to.
21+
2. Search for *Hotjar* in the Catalog, select it, and choose the Javascript source you want to connect the destination to.
2522

26-
3. Add your Hotjar Site ID to your Destination settings. You can find this under Settings and Sites & Organizations in your Hotjar dashboard. It should be a whole number (e.g. 123456).
23+
3. Add your **Hotjar Site ID** to your Destination settings. You can find this ID in Account settings > Sites & Organizations.
2724

28-
4. Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Hotjar's tracking snippet, along with your Site ID, onto the page. If you are already using Hotjar, remove Hotjar's snippet from your code.
29-
30-
Hotjar automatically starts tracking visitors based on the tools you have enabled in your Hotjar dashboard.
25+
Your changes will appear in the Segment CDN after 45 minutes, and then Analytics.js will start to asynchronously load Hotjar's tracking snippet and send data. If you're already using Hotjar, remove Hotjar's snippet from your code.
3126

3227
## Identify
3328

34-
The Hotjar destination will automatically ingest a User ID, as well as values sent over your Identify spec as [traits](/docs/connections/spec/identify/#traits), as long as [User Attributes are enabled in Hotjar](https://help.hotjar.com/hc/en-us/articles/360038394053-How-to-Setup-User-Attributes-in-4-Steps#step-2-review-your-privacy-requirements-and-enable-user-attributes).
29+
The Hotjar destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](/docs/connections/spec/identify/#traits), as long as session capture is enabled in Hotjar.
3530

3631
Identify calls that do not have a User ID value will not be sent to Hotjar.
3732

3833
### Nested values or lists
3934

40-
The Hotjar Identify API is unable to ingest values passed as nested objects or lists over your `identify` Spec:
35+
Currently, the Hotjar Identify API **does not** support ingesting values passed as nested objects or lists over your identify Spec:
4136

4237
```js
4338
"traits": {
@@ -54,6 +49,23 @@ The Hotjar Identify API is unable to ingest values passed as nested objects or l
5449
}
5550
```
5651
57-
In this example, Hotjar would reject all the values in the `address` field.
52+
In the example above, Hotjar rejects all the values in the `address` field.
53+
54+
## Track
55+
56+
The Hotjar destination automatically ingests any user actions tracked over your Track spec as [events](/docs/connections/spec/track/), as long as session capture is enabled in Hotjar.
57+
58+
### Event properties
59+
60+
Currently, the Hotjar Events API **does not** support ingesting event properties:
61+
62+
```js
63+
analytics.track("Experiment Viewed", {
64+
experiment_id: "1234",
65+
experiment_name: "new_upsell_UX"
66+
variation_id: "1234b"
67+
variation_name: "variant"
68+
});
69+
```
5870
59-
This is a recognized limitation of this version of the Hotjar Identify API, and as of February 3rd, 2020, is in the improvements backlog for the API.
71+
In the example above, Hotjar only ingests the event name, `Experiment Viewed`. All of its event properties are rejected.

0 commit comments

Comments
 (0)