Segment makes it easy to send your data to GoSquared (and lots of other destinations). Once you've tracked your data through our open source libraries we'll translate and route your data to GoSquared in the format they understand. Learn more about how to use GoSquared with Segment.
Getting Started
When you toggle on GoSquared in Segment, this is what happens:
- Our CDN is updated within 5-10 minutes. Then our snippet will start asynchronously loading GoSquared’s Tracker onto your page. This means you should remove any manual integration of GoSquared.
- Your GoSquared Now dashboard will instantly start showing the number of visitors online, and if you’re using
identify, users will start appearing in People Analytics.
GoSquared supports mobile, webpage and server-side tracking.
Website Tracking
When you enter your GoSquared site token into Segment, website tracking will automatically start.
Mobile and Server-Side Tracking
To track data via Segment’s mobile and server-side sources, you will need to enter a GoSquared API Key, which can be created in your GoSquared account. The API Key must have “Write Tracking” access. All functionality is supported by mobile and server-side tracking.
Page
When you call page, we call GoSquared’s track to track a pageview. By default the Segment JavaScript snippet includes a call to page so you don’t need to add it manually.
Page calls will be tracked from any Segment library, but GoSquared’s real-time analytics will be most accurate using front-end website tracking.
Identify
When you call identify, we call GoSquared’s identify. Once identified with a userId, that person (along with historical browsing information from before they were identified) will be visible and queryable in GoSquared People Analytics.
GoSquared expects a slightly different set of traits from us, so we start by transforming the traits to match their format.
| Our trait | GoSquared property |
|---|---|
firstName | first_name |
lastName | last_name |
createdAt | created_at |
title | company_position |
industry | company_industry |
GoSquared recognises certain traits as “special” and requires all other traits to be sent under a namespace of custom. The Segment code handles all of this, sending recognised special properties and custom properties in the correct places.
Track
When you call track, we call GoSquared’s event with the same arguments.
Screen
GoSquared supports the screen method by converting it into an event, with an event name of "Screen: " + name.
Group
GoSquared converts the group method into an identify call, to set the company details for a user. Only one company/group is supported per user.
Ecommerce
GoSquared supports our Ecommerce tracking API, so the Order Completed event will be tracked as a GoSquared Transaction.
Personas
You can send computed traits and audiences generated through Segment Personas to this destination as a user property. To learn more about Personas, reach out for a demo.
For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property order_completed_last_30days: true, and when this user no longer satisfies we will set that value to false.
When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.
Supported Sources and Connection Modes
| Web | Mobile | Server | |
|---|---|---|---|
| 📱 Device-based | ✅ | ||
| ☁️ Cloud-based | ✅ | ✅ |
To learn more about about Connection Modes and what dictates which we support, see here.
Settings
Segment lets you change these destination settings via your Segment dashboard without having to touch any code.
Anonymize IP
Enable if you need to anonymize the IP address of visitors to your website.
API Key (Server-side)
Generate your server-side API key here: https://www.gosquared.com/settings/api
Site Token
You can find your Site Token by viewing the GoSquared Integration guide. It should look something like GSN-123456-A.
Cookie Domain
Use this if you wish to share GoSquared’s tracking cookies across subdomains, .example.com will enable shared tracking across all example’s subdomains. By default, cookies are set on the current domain (including subdomain) only.
Track Hash
Enable if you’d like page hashes to be tracked alongside the page URL. By default, example.com/about#us will be tracked as example.com/about.
Track Local
Enable to track data on local pages/sites (using the file:// protocol, or on localhost). This helps prevent local development from polluting your stats.
Track Parameters
Disable to ignore URL querystring parameters from the page URL, for example /home?my=query&string=true will be tracked as /home if this is set to disabled.
Use Cookies
Disable this if you don’t want to use cookies
If you have any questions, or see anywhere we can improve our documentation, please let us know!