The GoSquared connector lets your AI agent act in each user's GoSquared account. Each user connects their own GoSquared API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 54 tools.
- Tools
- 54
- What they doRead · write · destructive
- 45 · 7 · 245 read7 write2 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the GoSquared connection
In AgentKit > Connections, create a GoSquared connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'gosquared'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize GoSquared:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'gosquared_archived_chats_list',toolInput: { site_token: 'GSN-106863-S' },})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "gosquared"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize GoSquared:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"site_token":"GSN-106863-S"},tool_name="gosquared_archived_chats_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their GoSquared credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolgosquared_archived_chats_listList archived chat conversations.Read-onlyList Archived Chats
List archived chat conversations. Returns chats with id and timestamps. Use this for past conversations.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_blocked_listList the project's blocked IPs, visitors and bot setting.Read-onlyList Blocked Items
List the project's blocked IPs, visitors and bot setting. Returns blocked ips, visitors and bots. Use this to audit tracking exclusions.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
presenterstring- Response shape. Example: plain.one of
plaintagsindexedTags
gosquared_chat_getGet one chat conversation.Read-onlyGet Chat
Get one chat conversation. Returns the chat with person, status and last activity. Use this when you know the chat ID.
Inputs
chat_idstringrequired- Chat ID (the client's person ID). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_chat_messages_listList the messages of a chat.Read-onlyList Chat Messages
List the messages of a chat. Returns messages with id, content, from (agent, client, bot) and timestamp. Use this to read a conversation.
Inputs
chat_idstringrequired- Chat ID (the client's person ID). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_chats_listList active chat conversations.Read-onlyList Active Chats
List active chat conversations. Returns chats with id (person ID), last message and timestamps. Use this to find open conversations. Use gosquared_archived_chats_list for archived ones.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_devices_listList all devices seen in People.Read-onlyList Devices
List all devices seen in People. Returns devices with id, browser, OS and person. Use gosquared_person_devices_list for one person.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
gosquared_event_types_listList the event names tracked in People.Read-onlyList Event Types
List the event names tracked in People. Returns event types with name and counts. Use this to build event filters.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_now_browsers_listList the browsers of visitors on the site right now.Read-onlyList Live Browsers
List the browsers of visitors on the site right now. Returns browsers with visitor counts. Use this for a live breakdown.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
presenterstring- Response shape. Example: plain.one of
plainkeyed
gosquared_now_campaigns_listList UTM campaigns that current visitors came from.Read-onlyList Live Campaigns
List UTM campaigns that current visitors came from. Returns campaigns with source, medium and visitor counts. Use this to see which campaigns are driving traffic now.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_now_concurrents_getGet the number of visitors on the site right now.Read-onlyGet Concurrent Visitors
Get the number of visitors on the site right now. Returns visitors, returning, pages and active engagement counts. Use this for a live headcount. Use gosquared_now_overview_get for more real-time metrics.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_now_countries_listList the countries of visitors on the site right now.Read-onlyList Live Countries
List the countries of visitors on the site right now. Returns countries with visitor counts. Use this for a live breakdown.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
presenterstring- Response shape. Example: plain.one of
plainkeyed
gosquared_now_engagement_getGet the engagement of current visitors (time on site, active vs idle).Read-onlyGet Live Engagement
Get the engagement of current visitors (time on site, active vs idle). Returns average engaged time and active visitor counts. Use this to gauge live attention.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_now_geo_getGet the map coordinates of current visitors.Read-onlyGet Live Visitor Locations
Get the map coordinates of current visitors. Returns visitors with latitude, longitude, city and country. Use this for a live map.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
visitors_modestring- Which visitors. Example: all.one of
alltaggedreturning
gosquared_now_notifications_listList traffic notifications (spikes, record days) for the project.Read-onlyList Notifications
List traffic notifications (spikes, record days) for the project. Returns notifications with type, message and timestamp. Use this to review alerts.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_now_organisations_listList the organisations of visitors on the site right now.Read-onlyList Live Organisations
List the organisations of visitors on the site right now. Returns organisations with visitor counts. Use this for a live breakdown.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
presenterstring- Response shape. Example: plain.one of
plainkeyed
gosquared_now_overview_getGet a real-time overview (visitors, returning visitors, pageviews, engagement) with the current day's peak.Read-onlyGet Real-Time Overview
Get a real-time overview (visitors, returning visitors, pageviews, engagement) with the current day's peak. Returns current counts and today's peaks. Use this for a live dashboard summary.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_now_pages_listList the pages with visitors on them right now.Read-onlyList Live Pages
List the pages with visitors on them right now. Returns pages with path, title and visitor count. Use this to see what people are reading now.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
hrefstring- Only this page URL. Example: https://example.com/pricing.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
gosquared_now_platforms_listList the platforms of visitors on the site right now.Read-onlyList Live Platforms
List the platforms of visitors on the site right now. Returns platforms with visitor counts. Use this for a live breakdown.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
presenterstring- Response shape. Example: plain.one of
plainkeyed
gosquared_now_sources_listList where current visitors came from (search, social, referrers, campaigns, direct...).Read-onlyList Live Traffic Sources
List where current visitors came from (search, social, referrers, campaigns, direct...). Returns source groups with counts and top referrers. Use this for live acquisition.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
drill_limitinteger- Items per source group. Example: 5.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
sectionsstring- Source groups to include, comma-separated (e.g. search, social, referrer, internal, direct, organic). Example: search,social,referrer.
gosquared_now_time_series_getGet visitor counts over today at a fixed interval.Read-onlyGet Real-Time Time Series
Get visitor counts over today at a fixed interval. Returns points with timestamp and visitor counts. Use this for today's traffic curve. Use gosquared_trends_aggregate_get for older periods.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
intervalstring- Interval between points, e.g. 5min or 15min. Example: 5min.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_now_visitor_getGet one online visitor and their recent pageviews and events.Read-onlyGet Online Visitor
Get one online visitor and their recent pageviews and events. Returns the visitor with location, device, referrer and page history. Use this for a visitor's live session.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
visitor_idstringrequired- Visitor ID from gosquared_now_visitors_list. Example: 4a2b1c3d5e6f.
presenterstring- Response shape. Example: events.one of
plaineventspageEvents
gosquared_now_visitors_listList visitors on the site right now (all, tagged or returning).Read-onlyList Online Visitors
List visitors on the site right now (all, tagged or returning). Returns visitors with id, location, browser, current page, referrer and engagement. Use this to see who is online. Use gosquared_now_visitor_get for one visitor.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
visitors_modestring- Which visitors. Example: all.one of
alltaggedreturning
gosquared_people_searchSearch and filter People CRM profiles by text and by property or event filters.Read-onlySearch People
Search and filter People CRM profiles by text and by property or event filters. Returns people with the requested fields and a total. Use this to find users. Use gosquared_person_get for one profile.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fieldsstring- Fields to return, comma-separated. Example: id,email,name,last.seen.
filtersstring- JSON array of filters, each with key (property or event), path, operator and value. Example: [{"key":"property","path":"email","operator":"contains","value":"example.com"}]
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
querystring- Search text. Example: jane.
sortstring- Property and direction. Example: last.seen:desc.
gosquared_person_devices_listList the devices a person has used, newest first.Read-onlyList Person Devices
List the devices a person has used, newest first. Returns devices with id, browser, OS and last seen. Use this to see how a person accesses your product.
Inputs
person_idstringrequired- People person ID (or email:<address>). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
gosquared_person_feed_getGet the activity feed (pageviews, events, sessions) of one person.Read-onlyGet Person Activity Feed
Get the activity feed (pageviews, events, sessions) of one person. Returns feed items with type, details and timestamp. Use this to see what a person did.
Inputs
person_idstringrequired- People person ID (or email:<address>). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
querystring- Search text within the feed. Example: pricing.
sortstring- Sort direction by time. Example: desc.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
typestring- Only this item type, e.g. event or pageview. Example: event.
gosquared_person_getGet one People CRM profile.Read-onlyGet Person
Get one People CRM profile. Returns the person's properties (email, name, company, custom properties, first/last seen, totals). Use this when you know the person ID or email.
Inputs
person_idstringrequired- People person ID (or email:<address>). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_property_types_listList all People property types (built-in and custom).Read-onlyList Property Types
List all People property types (built-in and custom). Returns properties with id, name and type. Use this to pick fields and filters.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_site_getGet one project's settings.Read-onlyGet Site
Get one project's settings. Returns the site's name, url, timezone and plan details. Use this to read project settings.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
site_token_pathstringrequired- Site token of the project to read (usually the same as site_token). Example: GSN-106863-S.
gosquared_sites_listList the projects (sites) in the account.Read-onlyList Sites
List the projects (sites) in the account. Returns sites with site_token, name, url and timezone. Use this to find site tokens.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
presenterstring- Response shape. Example: plain.one of
plainkeyed
gosquared_smartgroup_getGet one Smart Group.Read-onlyGet Smart Group
Get one Smart Group. Returns the group's name and filters. Use this to read a segment definition.
Inputs
group_idstringrequired- Smart Group ID from gosquared_smartgroups_list. Example: 58a2b1f8a1f8d24d1b2c3d4e.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_smartgroup_people_listList the people in a Smart Group.Read-onlyList Smart Group People
List the people in a Smart Group. Returns people with the requested fields and a total. Use this to export a segment.
Inputs
group_idstringrequired- Smart Group ID from gosquared_smartgroups_list. Example: 58a2b1f8a1f8d24d1b2c3d4e.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
fieldsstring- Fields to return, comma-separated. Example: id,email,name,last.seen.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
querystring- Search text. Example: jane.
sortstring- Property and direction. Example: last.seen:desc.
gosquared_smartgroups_listList People Smart Groups (saved filtered segments).Read-onlyList Smart Groups
List People Smart Groups (saved filtered segments). Returns groups with id, name, filters and counts. Use this for group IDs.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_trends_aggregate_getGet historical traffic totals (visitors, visits, pageviews, bounce rate, time on site) for a date range, by hour, day or month.Read-onlyGet Traffic Trends
Get historical traffic totals (visitors, visits, pageviews, bounce rate, time on site) for a date range, by hour, day or month. Returns totals and a list of data points per interval. Use this for historical traffic. Use gosquared_now_overview_get for right now.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
intervalstring- Bucket size. Example: day.one of
hourdaymonth limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_browser_listList browsers ranked by traffic over a date range.Read-onlyList Historical Browsers
List browsers ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_country_listList countries ranked by traffic over a date range.Read-onlyList Historical Countries
List countries ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_event_listList events ranked by traffic over a date range.Read-onlyList Historical Events
List events ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_organisation_listList organisations ranked by traffic over a date range.Read-onlyList Historical Organisations
List organisations ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_os_listList operating systems ranked by traffic over a date range.Read-onlyList Historical Operating Systems
List operating systems ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_page_listList pages ranked by traffic over a date range.Read-onlyList Historical Pages
List pages ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_path1_listList top-level paths ranked by traffic over a date range.Read-onlyList Historical Top-Level Paths
List top-level paths ranked by traffic over a date range. Returns items with name and metrics (visitors, pageviews or event counts). Use this for historical breakdowns.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trends_sources_listList traffic sources over a date range, optionally one source type (search, social, referrer, direct...).Read-onlyList Historical Sources
List traffic sources over a date range, optionally one source type (search, social, referrer, direct...). Returns sources with type, name and visits. Use this for historical acquisition.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
date_formatstring- Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
formatstring- Response format. Example: json.one of
jsoncsv fromstring- Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
groupboolean- Group sources by type. Example: true.
limitstring- Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
source_typestring- Only this source type, e.g. search, social, referrer, direct, internal, email. Example: social.
tostring- End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
gosquared_trigger_types_listList the webhook trigger types.Read-onlyList Trigger Types
List the webhook trigger types. Returns trigger types with name and description. Use this before adding webhook triggers.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_webhook_getGet one webhook.Read-onlyGet Webhook
Get one webhook. Returns its name, url and triggers. Use this when you know the ID.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
webhook_idintegerrequired- Webhook ID from gosquared_webhooks_list. Example: 1234.
gosquared_webhooks_listList the project's webhooks.Read-onlyList Webhooks
List the project's webhooks. Returns webhooks with id, name, url and triggers. Use this to review integrations.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_chat_archiveArchive a chat conversation.WriteArchive Chat
Archive a chat conversation. Returns an empty response on success. Use this when a conversation is resolved. Use gosquared_chat_unarchive to reopen it.
Inputs
chat_idstringrequired- Chat ID (the client's person ID). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_chat_message_sendSend a chat message to a person as an agent (the API key's owner).WriteSend Chat Message
Send a chat message to a person as an agent (the API key's owner). Returns the created message. Use this to reply in a conversation.
Inputs
chat_idstringrequired- Chat ID (the client's person ID). Example: email:jane@example.com.
contentstringrequired- Message text. Example: Thanks for reaching out! Looking into it now.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_chat_unarchiveUnarchive a chat conversation.WriteUnarchive Chat
Unarchive a chat conversation. Returns an empty response on success. Use this to reopen a conversation.
Inputs
chat_idstringrequired- Chat ID (the client's person ID). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
gosquared_smartgroup_createCreate a Smart Group from People filters.WriteCreate Smart Group
Create a Smart Group from People filters. Returns the created group. Use this to save a segment.
Inputs
filtersarrayrequired- Filters, each with key (property or event), path, operator and value. Example: [{"key": "property", "path": "email", "operator": "contains", "value": "example.com"}]
namestringrequired- Group name. Example: sk-test active trials.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
sort_dirstring- Sort direction. Example: desc.one of
ascdesc sort_fieldstring- Default sort property. Example: last.seen.
gosquared_track_eventTrack a custom event for a person or anonymous visitor (shows in Trends and People).WriteTrack Event
Track a custom event for a person or anonymous visitor (shows in Trends and People). Returns an empty success response. Use this to record a server-side action. Use gosquared_track_properties to update profile data.
Inputs
event_namestringrequired- Event name (up to 1000 distinct names per project). Example: Signed Up.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
event_dataobject- Extra event properties. Example: {"plan": "pro"}
person_idstring- Person ID or email:<address>. Example: email:jane@example.com.
timestampstring- ISO 8601 time of the event. Example: 2026-01-15T10:00:00Z.
visitor_idstring- Anonymous visitor ID. Example: 4a2b1c3d5e6f.
gosquared_track_propertiesCreate or update a People profile's properties (email, name, company, custom properties) and optionally link an anonymous visitor.WriteTrack Person Properties
Create or update a People profile's properties (email, name, company, custom properties) and optionally link an anonymous visitor. Returns an empty success response. Use this to identify users from your backend. Use gosquared_track_event for actions.
Inputs
person_idstringrequired- Person ID or email:<address>. Example: email:jane@example.com.
propertiesobjectrequired- Properties: email, name, first_name, last_name, created_at, phone, company (name, size, industry, position) and custom (any key-values). Example: {"email": "jane@example.com", "name": "Jane Doe", "company": {"name": "Acme"}, "custom": {"plan": "pro"}}
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
visitor_idstring- Anonymous visitor ID to merge into the profile. Example: 4a2b1c3d5e6f.
gosquared_track_transactionTrack an ecommerce transaction (revenue, quantity, items) for a person or visitor.WriteTrack Transaction
Track an ecommerce transaction (revenue, quantity, items) for a person or visitor. Returns an empty success response. Use this to record a sale for Ecommerce reports.
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
transactionobjectrequired- Transaction with id and optional revenue, quantity and items (name, price, quantity, categories). Example: {"id": "order-1001", "revenue": 49.9, "quantity": 1, "items": [{"name": "T-shirt", "price": 49.9, "quantity": 1}]}
person_idstring- Person ID or email:<address>. Example: email:jane@example.com.
timestampstring- ISO 8601 time of the transaction. Example: 2026-01-15T10:00:00Z.
visitor_idstring- Anonymous visitor ID. Example: 4a2b1c3d5e6f.
gosquared_person_deleteDelete a People CRM profile and its data; with blacklist=true GoSquared also ignores the person in future.DestructiveDelete Person
Delete a People CRM profile and its data; with blacklist=true GoSquared also ignores the person in future. Needs an API key with Write People permission. Returns an empty response on success. Use this for data deletion requests. It cannot be undone.
- Idempotent
Inputs
person_idstringrequired- People person ID (or email:<address>). Example: email:jane@example.com.
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
blacklistboolean- Also blacklist the person's IDs and email. Example: false.
gosquared_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook. Returns an empty response on success. Use this to remove an integration.
- Idempotent
Inputs
site_tokenstringrequired- The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
webhook_idintegerrequired- Webhook ID from gosquared_webhooks_list. Example: 1234.
No tools match.