> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to GoSquared

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.

**Authentication:** API Key
**Categories:** Analytics, Customer Support
**Tools:** 54: 45 read, 7 write, 2 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=GOSQUARED)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the GoSquared connection

   In **AgentKit > Connections**, create a GoSquared connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'gosquared'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'gosquared_archived_chats_list',
     toolInput: { site_token: 'GSN-106863-S' },
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "gosquared"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={"site_token":"GSN-106863-S"},
       tool_name="gosquared_archived_chats_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their GoSquared credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'gosquared_archived_chats_list',
  toolInput: {
    site_token: '<site_token>',
  },
  connector: 'gosquared',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="gosquared_archived_chats_list",
    tool_input={
        "site_token": "<site_token>",
    },
    connection_name="gosquared",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `gosquared_archived_chats_list`

List Archived Chats · Read-only

List archived chat conversations. Returns chats with id and timestamps. Use this for past conversations.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_blocked_list`

List Blocked Items · Read-only

List the project's blocked IPs, visitors and bot setting. Returns blocked ips, visitors and bots. Use this to audit tracking exclusions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `tags`, `indexedTags`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_chat_get`

Get Chat · Read-only

Get one chat conversation. Returns the chat with person, status and last activity. Use this when you know the chat ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `chat_id` (`string`, required): Chat ID (the client's person ID). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"chat_id":"<chat_id>","site_token":"<site_token>"}`

### `gosquared_chat_messages_list`

List Chat Messages · Read-only

List the messages of a chat. Returns messages with id, content, from (agent, client, bot) and timestamp. Use this to read a conversation.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `chat_id` (`string`, required): Chat ID (the client's person ID). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"chat_id":"<chat_id>","site_token":"<site_token>"}`

### `gosquared_chats_list`

List Active Chats · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_devices_list`

List Devices · Read-only

List all devices seen in People. Returns devices with id, browser, OS and person. Use gosquared_person_devices_list for one person.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_event_types_list`

List Event Types · Read-only

List the event names tracked in People. Returns event types with name and counts. Use this to build event filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_browsers_list`

List Live Browsers · Read-only

List the browsers of visitors on the site right now. Returns browsers with visitor counts. Use this for a live breakdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `keyed`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_campaigns_list`

List Live Campaigns · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_concurrents_get`

Get Concurrent Visitors · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_countries_list`

List Live Countries · Read-only

List the countries of visitors on the site right now. Returns countries with visitor counts. Use this for a live breakdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `keyed`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_engagement_get`

Get Live Engagement · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_geo_get`

Get Live Visitor Locations · Read-only

Get the map coordinates of current visitors. Returns visitors with latitude, longitude, city and country. Use this for a live map.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `visitors_mode` (`string`, optional): Which visitors. Example: all. One of: `all`, `tagged`, `returning`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_notifications_list`

List Notifications · Read-only

List traffic notifications (spikes, record days) for the project. Returns notifications with type, message and timestamp. Use this to review alerts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_organisations_list`

List Live Organisations · Read-only

List the organisations of visitors on the site right now. Returns organisations with visitor counts. Use this for a live breakdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `keyed`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_overview_get`

Get Real-Time Overview · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_pages_list`

List Live Pages · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `href` (`string`, optional): Only this page URL. Example: https://example.com/pricing.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_platforms_list`

List Live Platforms · Read-only

List the platforms of visitors on the site right now. Returns platforms with visitor counts. Use this for a live breakdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `keyed`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_sources_list`

List Live Traffic Sources · Read-only

List where current visitors came from (search, social, referrers, campaigns, direct...). Returns source groups with counts and top referrers. Use this for live acquisition.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `drill_limit` (`integer`, optional): Items per source group. Example: 5.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `sections` (`string`, optional): Source groups to include, comma-separated (e.g. search, social, referrer, internal, direct, organic). Example: search,social,referrer.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_time_series_get`

Get Real-Time Time Series · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `interval` (`string`, optional): Interval between points, e.g. 5min or 15min. Example: 5min.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_now_visitor_get`

Get Online Visitor · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `visitor_id` (`string`, required): Visitor ID from gosquared_now_visitors_list. Example: 4a2b1c3d5e6f.
- `presenter` (`string`, optional): Response shape. Example: events. One of: `plain`, `events`, `pageEvents`.

Example input: `{"site_token":"<site_token>","visitor_id":"<visitor_id>"}`

### `gosquared_now_visitors_list`

List Online Visitors · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
- `visitors_mode` (`string`, optional): Which visitors. Example: all. One of: `all`, `tagged`, `returning`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_people_search`

Search People · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `fields` (`string`, optional): Fields to return, comma-separated. Example: id,email,name,last.seen.
- `filters` (`string`, optional): JSON array of filters, each with key (property or event), path, operator and value. Example: [{"key":"property","path":"email","operator":"contains","value":"example.com"}]
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `query` (`string`, optional): Search text. Example: jane.
- `sort` (`string`, optional): Property and direction. Example: last.seen:desc.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_person_devices_list`

List Person Devices · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`string`, required): People person ID (or email:<address>). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.

Example input: `{"person_id":"<person_id>","site_token":"<site_token>"}`

### `gosquared_person_feed_get`

Get Person Activity Feed · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`string`, required): People person ID (or email:<address>). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `query` (`string`, optional): Search text within the feed. Example: pricing.
- `sort` (`string`, optional): Sort direction by time. Example: desc.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
- `type` (`string`, optional): Only this item type, e.g. event or pageview. Example: event.

Example input: `{"person_id":"<person_id>","site_token":"<site_token>"}`

### `gosquared_person_get`

Get Person · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`string`, required): People person ID (or email:<address>). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"person_id":"<person_id>","site_token":"<site_token>"}`

### `gosquared_property_types_list`

List Property Types · Read-only

List all People property types (built-in and custom). Returns properties with id, name and type. Use this to pick fields and filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_shared_users_list`

List Team Members · Read-only

List team members (shared users) of the project. Returns users with email, role and status. Use this to see who has access.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_site_get`

Get Site · Read-only

Get one project's settings. Returns the site's name, url, timezone and plan details. Use this to read project settings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `site_token_path` (`string`, required): Site token of the project to read (usually the same as site_token). Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>","site_token_path":"<site_token_path>"}`

### `gosquared_sites_list`

List Sites · Read-only

List the projects (sites) in the account. Returns sites with site_token, name, url and timezone. Use this to find site tokens.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `presenter` (`string`, optional): Response shape. Example: plain. One of: `plain`, `keyed`.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_smartgroup_get`

Get Smart Group · Read-only

Get one Smart Group. Returns the group's name and filters. Use this to read a segment definition.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): Smart Group ID from gosquared_smartgroups_list. Example: 58a2b1f8a1f8d24d1b2c3d4e.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"group_id":"<group_id>","site_token":"<site_token>"}`

### `gosquared_smartgroup_people_list`

List Smart Group People · Read-only

List the people in a Smart Group. Returns people with the requested fields and a total. Use this to export a segment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `group_id` (`string`, required): Smart Group ID from gosquared_smartgroups_list. Example: 58a2b1f8a1f8d24d1b2c3d4e.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `fields` (`string`, optional): Fields to return, comma-separated. Example: id,email,name,last.seen.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
- `query` (`string`, optional): Search text. Example: jane.
- `sort` (`string`, optional): Property and direction. Example: last.seen:desc.

Example input: `{"group_id":"<group_id>","site_token":"<site_token>"}`

### `gosquared_smartgroups_list`

List Smart Groups · Read-only

List People Smart Groups (saved filtered segments). Returns groups with id, name, filters and counts. Use this for group IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_aggregate_get`

Get Traffic Trends · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `interval` (`string`, optional): Bucket size. Example: day. One of: `hour`, `day`, `month`.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_browser_list`

List Historical Browsers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_country_list`

List Historical Countries · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_event_list`

List Historical Events · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_organisation_list`

List Historical Organisations · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_os_list`

List Historical Operating Systems · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_page_list`

List Historical Pages · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_path1_list`

List Historical Top-Level Paths · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trends_sources_list`

List Historical Sources · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `date_format` (`string`, optional): Format for dates in the response (any Moment.js format). Example: YYYY-MM-DD.
- `format` (`string`, optional): Response format. Example: json. One of: `json`, `csv`.
- `from` (`string`, optional): Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
- `group` (`boolean`, optional): Group sources by type. Example: true.
- `limit` (`string`, optional): Maximum results, or offset,count (e.g. 5,10). Example: 0,20.
- `source_type` (`string`, optional): Only this source type, e.g. search, social, referrer, direct, internal, email. Example: social.
- `to` (`string`, optional): End date-time of the range (ISO 8601 or now). Example: 2026-01-31.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_trigger_types_list`

List Trigger Types · Read-only

List the webhook trigger types. Returns trigger types with name and description. Use this before adding webhook triggers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_webhook_get`

Get Webhook · Read-only

Get one webhook. Returns its name, url and triggers. Use this when you know the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `webhook_id` (`integer`, required): Webhook ID from gosquared_webhooks_list. Example: 1234.

Example input: `{"site_token":"<site_token>","webhook_id":1234}`

### `gosquared_webhooks_list`

List Webhooks · Read-only

List the project's webhooks. Returns webhooks with id, name, url and triggers. Use this to review integrations.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"site_token":"<site_token>"}`

### `gosquared_chat_archive`

Archive Chat · Write

Archive a chat conversation. Returns an empty response on success. Use this when a conversation is resolved. Use gosquared_chat_unarchive to reopen it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `chat_id` (`string`, required): Chat ID (the client's person ID). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"chat_id":"<chat_id>","site_token":"<site_token>"}`

### `gosquared_chat_message_send`

Send Chat Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `chat_id` (`string`, required): Chat ID (the client's person ID). Example: email:jane@example.com.
- `content` (`string`, required): Message text. Example: Thanks for reaching out! Looking into it now.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"chat_id":"<chat_id>","content":"<content>","site_token":"<site_token>"}`

### `gosquared_chat_unarchive`

Unarchive Chat · Write

Unarchive a chat conversation. Returns an empty response on success. Use this to reopen a conversation.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `chat_id` (`string`, required): Chat ID (the client's person ID). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.

Example input: `{"chat_id":"<chat_id>","site_token":"<site_token>"}`

### `gosquared_smartgroup_create`

Create Smart Group · Write

Create a Smart Group from People filters. Returns the created group. Use this to save a segment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `filters` (`array`, required): Filters, each with key (property or event), path, operator and value. Example: [{"key": "property", "path": "email", "operator": "contains", "value": "example.com"}]
- `name` (`string`, required): Group name. Example: sk-test active trials.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `sort_dir` (`string`, optional): Sort direction. Example: desc. One of: `asc`, `desc`.
- `sort_field` (`string`, optional): Default sort property. Example: last.seen.

Example input: `{"filters":[{"key":"property","path":"email","operator":"contains","value":"example.com"}],"name":"<name>","site_token":"<site_token>"}`

### `gosquared_track_event`

Track Event · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `event_name` (`string`, required): Event name (up to 1000 distinct names per project). Example: Signed Up.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `event_data` (`object`, optional): Extra event properties. Example: {"plan": "pro"}
- `person_id` (`string`, optional): Person ID or email:<address>. Example: email:jane@example.com.
- `timestamp` (`string`, optional): ISO 8601 time of the event. Example: 2026-01-15T10:00:00Z.
- `visitor_id` (`string`, optional): Anonymous visitor ID. Example: 4a2b1c3d5e6f.

Example input: `{"event_name":"<event_name>","site_token":"<site_token>"}`

### `gosquared_track_properties`

Track Person Properties · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `person_id` (`string`, required): Person ID or email:<address>. Example: email:jane@example.com.
- `properties` (`object`, required): 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_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `visitor_id` (`string`, optional): Anonymous visitor ID to merge into the profile. Example: 4a2b1c3d5e6f.

Example input: `{"person_id":"<person_id>","properties":{},"site_token":"<site_token>"}`

### `gosquared_track_transaction`

Track Transaction · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `transaction` (`object`, required): 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_id` (`string`, optional): Person ID or email:<address>. Example: email:jane@example.com.
- `timestamp` (`string`, optional): ISO 8601 time of the transaction. Example: 2026-01-15T10:00:00Z.
- `visitor_id` (`string`, optional): Anonymous visitor ID. Example: 4a2b1c3d5e6f.

Example input: `{"site_token":"<site_token>","transaction":{}}`

### `gosquared_person_delete`

Delete Person · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `person_id` (`string`, required): People person ID (or email:<address>). Example: email:jane@example.com.
- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `blacklist` (`boolean`, optional): Also blacklist the person's IDs and email. Example: false.

Example input: `{"person_id":"<person_id>","site_token":"<site_token>"}`

### `gosquared_webhook_delete`

Delete Webhook · Destructive

Delete a webhook. Returns an empty response on success. Use this to remove an integration.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `site_token` (`string`, required): The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
- `webhook_id` (`integer`, required): Webhook ID from gosquared_webhooks_list. Example: 1234.

Example input: `{"site_token":"<site_token>","webhook_id":1234}`

## Related

Other Analytics connectors ([all 177](/agentkit/connectors/?category=analytics)):

- [Google Sheets](/agentkit/connectors/googlesheets/): Scalekit connector, OAuth, 48 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [AWS Redshift](/agentkit/connectors/redshift/): Scalekit connector, Trusted identity provider, 10 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
