GoSquared Destination

Destination Info
Connection Modes
Device-mode Cloud-mode
Web Web
Mobile Mobile
Server Server

Getting Started

When you enable GoSquared in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts 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 using 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.


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.


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.


When you call track, we call GoSquared’s event with the same arguments.


GoSquared supports the screen method by converting it into an event, with an event name of "Screen: " + name.


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.


GoSquared supports our Ecommerce tracking API, so the Order Completed event will be tracked as a GoSquared Transaction.


You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Real-time to batch destination sync frequency

Real-time audience syncs to GoSquared may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
Anonymize IP boolean, defaults to FALSE .

Enable if you need to anonymize the IP address of visitors to your website.
API Key (Server-side)
string. Generate your server-side API key here: https://www.gosquared.com/settings/api
Site Token
string. You can find your Site Token by viewing the GoSquared Integration guide. It should look something like GSN-123456-A.
string. 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 boolean, defaults to FALSE .

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 boolean, defaults to FALSE .

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 boolean, defaults to TRUE .

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 boolean, defaults to TRUE .

Disable this if you don’t want to use cookies

This page was last modified: 08 Mar 2022

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
Create free account