Your AI team, working in Gosquared

GoSquared provides real-time web analytics and customer engagement tools to help businesses understand and interact with their website visitors.

Start your company

What your team can do in Gosquared

90 tools to work with, connected with an API key.

Account Shared UsersReads only

Retrieves all team members who have access to the current GoSquared project. Returns each user's ID, email, access state (owner/active/pending), and role (owner/admin/member). Requires an API key with owner-level permissions for the project. Use this to audit project access or verify team member invitations.

Add Account Site

Create a new site/project in the GoSquared account for analytics tracking using an API key with write_account scope. The response includes the raw API response and may include the site token needed to configure tracking.

Add Shared User

Tool to add a new shared user to a project. Use when inviting team members via their email address.

Archive Chat Conversation

Archives a chat conversation in GoSquared Inbox. Use this action to close out completed chat sessions, move resolved conversations out of the active inbox, or organize chat history. Archived chats can be retrieved later using the archived chats endpoint or unarchived using the 'Unarchive Chat Conversation' action.

Block Visitor

Tool to block a specific visitor from being tracked. Use when you need to prevent tracking for a particular visitor ID.

Check API Token Validity and ScopesReads only

Tool to check whether an API key is valid and retrieve its enabled scopes. Use when verifying API credentials before making further API calls.

Create Account Webhook

Tool to create a webhook to receive notifications about events in a GoSquared project. Use when you need to register a new webhook endpoint for real-time event notifications.

Create People SmartGroup

Create a new Smart Group in GoSquared People CRM to segment users by custom criteria. Smart Groups are dynamic user segments based on property filters (like email, name, status) or event-based filters. Filters can use various operators including 'contains', 'eq' (equals), 'gt'/'lt' (greater/less than), '~' (is/equals), and '><' (date range). Use this when you need to: - Create user segments based on properties (e.g., email domain, subscription status) - Filter users by date ranges (e.g., created in last 7 days) - Combine multiple filter criteria (filters work as AND logic) - Organize users for targeted campaigns or analysis

Create Webhook Trigger

Tool to add a trigger to an existing GoSquared webhook. Use when configuring webhook alerts for traffic spikes, traffic dips, chat messages, or smart group events.

Delete Account Webhook

Tool to delete a webhook from a GoSquared account. Use when you need to remove an existing webhook by its ID.

Delete person

Tool to delete a person profile and all associated data. Use when you need to permanently remove a person's record and optionally blacklist them.

Export Smart Group FeedReads only

Export all pageview activity for users in a Smart Group to a downloadable CSV file. Returns a time-limited URL (valid for 15 minutes) to download the CSV. Supports filtering by date range (max 60 days). Use this when you need bulk export of user pageview data for analytics or reporting purposes.

Get Account Blocked BotsReads only

Tool to retrieve the bot blocking status for a GoSquared project. Use when you need to check whether automatic bot blocking is enabled.

Get Account Blocked ItemsReads only

Tool to retrieve a list of blocked IP addresses, bots, and visitors for a project. Use when you need to see all blocked items across all categories.

Get Account Blocked VisitorsReads only

Tool to retrieve visitor IDs that have been blocked for a project. Use when you need to list visitors who were blocked (typically via the 'Ignore' button in the visitor widget).

Get Account Site DetailsReads only

Tool to retrieve detailed information about a specific site/project by its site_token. Use when you need to fetch configuration details, ownership info, or metadata for a particular GoSquared project.

Get Account Sites UsageReads only

Tool to retrieve all sites and their pageview counts for the authenticated account. Use when you need to get usage statistics across all sites. Optionally filter by date range using 'from' and 'to' parameters.

Get Account Tagged VisitorsReads only

Tool to retrieve the list of tagged visitors from the account. Use when you need to see which visitors have been tagged and their associated tags.

Get Account Trigger TypeReads only

Tool to retrieve details of a specific trigger type from GoSquared. Use when you need to understand the payload structure and fields for a particular trigger type before setting up automation workflows or webhooks.

Get Account Trigger TypesReads only

Tool to retrieve available types of triggers in GoSquared. Use when you need to discover what trigger types are supported for automation workflows or webhook configurations.

Get Account WebhookReads only

Tool to retrieve a specific webhook by ID from a GoSquared account. Use when you need to fetch details about an existing webhook configuration.

Get Account Webhook TriggersReads only

Retrieve the triggers configured for a webhook by its numeric ID. Use this to see which events are configured to fire the webhook.

Get Account WebhooksReads only

Retrieve webhooks configured for the GoSquared project, including available details such as ID, URL, event type, and active status. Use this to audit webhook configurations or verify integrations.

Get Base Path MetricsReads only

Retrieves base path metrics (first URL path segments) over a time period for analyzing traffic to top-level site sections, using an API key with the 'read_trends' scope. When CSV is requested, the returned structured result has an empty list and does not include the CSV data.

Get Blocked IP AddressesReads only

Tool to retrieve the list of blocked IP addresses for the account. Use when you need to view which IP addresses are currently blocked from tracking or accessing the site.

Get Browser MetricsReads only

Tool to retrieve summarised browser metrics over a specified time period. Use when analyzing which browsers were used to access the site during a specific date range.

Get Campaign Content MetricsReads only

Retrieve UTM content metrics (utm_content) aggregated over a specified date range. Use this to analyze which content variations (e.g., banner ads, sidebar links, footer CTAs) are driving traffic to your site.

Get Campaign Medium MetricsReads only

Retrieve UTM medium metrics (utm_medium) aggregated over a specified date range. Use this to analyze which marketing mediums (e.g., email, social, cpc, organic) are driving traffic to your site.

Get Campaign Name MetricsReads only

Retrieve UTM campaign name metrics (utm_campaign) aggregated over a specified date range. Use this to analyze which marketing campaigns (e.g., 'spring_sale', 'newsletter_2024') are driving traffic to your site.

Get Campaign Source MetricsReads only

Retrieve UTM source metrics (utm_source) aggregated over a specified date range. Use this to analyze which traffic sources (e.g., google, facebook, newsletter) are driving visitors to your site.

Get Campaign Term MetricsReads only

Retrieve UTM term metrics (utm_term) aggregated over a specified date range. Use this to analyze which specific keywords or terms are driving traffic to your site.

Get Category MetricsReads only

Tool to retrieve summarised category metrics over a specified time period. Use when analyzing which content categories were accessed during a specific date range.

Get Country MetricsReads only

Retrieve country-level visit metrics aggregated over a specified date range. Use this to analyze which countries are driving traffic to your site during a specific period.

Get current concurrent visitorsReads only

Tool to retrieve the number of concurrent visitors currently on your site. Use when you need live, real-time visitor metrics.

Get Current TimeReads only

Tool to retrieve the current time according to GoSquared infrastructure. Use when you need a synchronized timestamp from GoSquared's servers.

Get Language MetricsReads only

Retrieve summarised language metrics over a given time period. Use this to analyze which languages your visitors are using based on browser settings. Returns a ranked list of languages by visitor count within the specified date range.

Get Now NotificationsReads only

Tool to retrieve notifications stored in GoSquared. Use when you need to access Traffic Alerts, RSS feed items, or Milestones.

Get Now Sources By SectionReads only

Tool to retrieve a specific group of real-time traffic sources such as 'site', 'organic', or 'social'. Use when you need up-to-the-minute data about a particular source category driving visitors to your site.

Get Operating System MetricsReads only

Tool to retrieve summarised operating system metrics over a specified time period. Use when analyzing which operating systems were used to access the site during a specific date range.

Get Organisation MetricsReads only

Tool to retrieve summarised organisation metrics over a given time period. Use when analyzing which internet organisations (ISPs, network providers, companies) are driving traffic to your site during a specific date range.

Get Page MetricsReads only

Retrieve page-level visit metrics over a specified time period. Returns a ranked list of pages by visit count within the date range. Use this to analyze which pages received the most traffic during a specific period.

Get People Event TypesReads only

Retrieve all event types tracked in GoSquared People CRM, ordered by frequency. Use this to discover available events for filtering or building Smart Groups.

Get People Property TypesReads only

Retrieve property types (schema definitions) from GoSquared People CRM. Use this tool to: - Discover all available profile properties and their data types - Get custom property definitions - Look up a specific property's schema by its identifier Properties use dot notation for nested fields (e.g., 'last.location.country').

Get Person ProfileReads only

Retrieve a specific person's profile from GoSquared People CRM by their unique ID. Use this tool when you need to: - Fetch detailed profile information for a known person - Look up custom properties set via tracking for a specific user - Verify a person exists before performing other operations Prerequisites: - Requires a valid person_id (obtain from List People or tracking events) - API key must have 'read_people' scope Returns the complete person profile including standard fields and custom properties.

Get Product MetricsReads only

Tool to retrieve summarised product metrics over a specified time period. Use when analyzing ecommerce product performance, revenue, and transaction data during a specific date range.

Get Real-Time CampaignsReads only

Tool to retrieve currently running campaigns with real-time visitor counts. Use when you need to see which campaigns are actively driving visitors to the site right now.

Get Real-Time EngagementReads only

Tool to retrieve engagement information of currently online users. Use when you need real-time metrics about visitor behavior including time on site and visit depth.

Get Real-Time Online VisitorsReads only

Tool to retrieve a list of current online visitors. Use when you need detailed real-time visitor information.

Get Real-Time OrganisationsReads only

Tool to retrieve internet organisations currently being used by online visitors, sorted by visitor count. Use when you need real-time data about which ISPs or network providers your visitors are using.

Get Real-Time OverviewReads only

Tool to retrieve a summary of real-time data for the site. Use when a snapshot of current online visitor metrics and summary statistics is needed.

Get Real-Time Popular PagesReads only

Retrieve the most popular pages currently being viewed on your site in real-time. Returns pages ordered by visitor count. Use this tool when you need to know which pages are currently active and how many visitors are on each page right now.

Get Real-Time Visitor BrowsersReads only

Tool to retrieve browsers used by currently online visitors, sorted by visitor count. Use when you need real-time breakdown of which browsers active visitors are using.

Get Real-Time Visitor CountriesReads only

Tool to retrieve countries where currently online visitors are located, sorted by visitor count. Use when you need real-time geographic distribution of active site visitors.

Get Real-Time Visitor Geo LocationsReads only

Tool to retrieve real-time geographic coordinates for currently online visitors. Returns latitude/longitude coordinates with visitor counts for each location. Use when you need to visualize or analyze the geographic distribution of active site visitors.

Get Real-Time Visitor LanguagesReads only

Tool to retrieve languages for currently online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor languages.

Get Real-Time Visitor PlatformsReads only

Tool to retrieve platforms used by online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor platforms.

Get Screen Dimensions MetricsReads only

Tool to retrieve summarised screen dimensions metrics over a specified time period. Use when analyzing which screen dimensions (resolutions) were used to access the site during a specific date range.

Get Specific Chat MessageReads only

Retrieve a specific chat message by its message ID from a chat conversation. Use this tool when you need to fetch details of a particular message, such as its content, sender, and timestamp. Requires both the chat ID (same as person_id) and the specific message ID (UUID format).

Get Specific VisitorReads only

Retrieves real-time session information for a specific online visitor. Use this tool after obtaining a visitorID from GOSQUARED_NOW_VISITORS to get detailed information about a visitor including their location, browser, engagement score, and event history. Returns a 409 status if the visitor is no longer online.

Get Traffic Sources MetricsReads only

Tool to retrieve a historical list of traffic sources that referred visitors to the site over a specified period. Sources are grouped by category: direct, organic (search engines), site (referrals), social, and internal. Use when analyzing which sources drove traffic during a specific date range.

Get Transaction MetricsReads only

Tool to retrieve summarised transaction metrics over a specified time period. Use when analyzing transaction data including revenue and quantity during a specific date range.

Get Trends Sources By TypeReads only

Tool to retrieve a historical list of sources for the given section type. Use when analyzing which sources (referring websites, social media, search engines, or internal) drove traffic during a specific time period.

Get Visitor Time SeriesReads only

Retrieves time series data showing the number of concurrent visitors to your site over time. Use this tool when you need to analyze visitor traffic patterns, identify peak hours, or track historical visitor trends. Returns data points at regular intervals (configurable, default 5 minutes) within the specified time range.

GoSquared - Get Person FeedReads only

Retrieve a person's event feed from GoSquared People CRM, with pagination and optional search, event-type and time filters. Results default to the first 10 events sorted newest first; the sort order can be changed.

GoSquared - List All DevicesReads only

Retrieve a paginated list of all devices tracked in GoSquared People CRM. This tool returns information about every device that has ever been tracked, including platform (OS), browser, screen size, ISP, geographic location, and visit counts. Use this when you need an overview of all devices accessing your site/app or for device analytics. Note: Requires API key with 'read_people' scope.

Identify User

Identify a user in GoSquared and set their profile properties. Links anonymous visitor activity to a known user identity and creates/updates their profile in the People dashboard. Requires 'write_tracking' API scope.

Leave Chat Note

Adds an internal note to a GoSquared chat conversation. Notes are visible only to agents in the Inbox and are useful for leaving context, follow-up reminders, or team coordination messages. The chatID corresponds to the person_id of the visitor/client.

List Account SitesReads only

List all projects/sites accessible to the authenticated account. Requires 'read_account' API key scope. Use 'grouped' format to see owned vs shared sites, or 'flat' for a simple list.

List PeopleReads only

Search and filter tracked people in GoSquared People CRM by text, properties, or events, with sorting and pagination. Results can be requested as JSON or CSV; JSON may include matching counts and pagination links.

List People Smart GroupsReads only

Retrieve all Smart Groups for a GoSquared People CRM project. Smart Groups are saved user segments based on property or event filters. Use this action to list all configured Smart Groups and their filter criteria. The returned group IDs can be used with other People API endpoints to query users within specific segments. Requires the 'read_people' API key scope.

Now SourcesReads only

Tool to retrieve the most influential traffic sources currently driving visitors to your site. Use when you need an up-to-the-minute breakdown of referrer sources.

Remove shared user

Removes a shared user from a GoSquared project by their email address, revoking their access to the site. Requires owner-level API key permissions. Use GOSQUARED_ACCOUNT_SHARED_USERS first to list current shared users.

Retrieve Aggregate MetricsReads only

Retrieve aggregate web analytics metrics for a specified time period. Returns key metrics like pageviews, unique visitors, visits, bounce rate, engaged time, and e-commerce data, grouped by hour, day, or month. Use this tool to analyze overall website traffic trends and performance over time.

Retrieve Chat ConversationReads only

Retrieve detailed information about a chat conversation by its ID. Use this tool when you need to: - Get the current state of a chat conversation (agent assignment, read status) - View the latest message in a conversation - Check visitor presence and contact details - Determine if a chat is archived or active Prerequisites: Obtain a valid chatID from GOSQUARED_CHAT_CHATS or use a person_id from GOSQUARED_LIST_PEOPLE. Note: To retrieve the full conversation history with all messages, use GOSQUARED_CHAT_FEED instead. This endpoint returns summary information and only the latest message.

Retrieve Chat ConversationsReads only

Tool to retrieve chat data for reporting purposes. Use when you need to list active chat conversations within a specific time window.

Retrieve Chat FeedReads only

Retrieve a chat conversation's feed of messages and events by chat ID. Supports pagination and date filtering for portions of the conversation history.

Retrieve Chat MessagesReads only

Retrieve messages from a GoSquared chat conversation by chat ID. Use this tool to: - Fetch message history from a specific chat conversation - Page through chat messages with offset and limit - Filter messages by date range - Get the total count of messages via the cardinality field Prerequisites: - Obtain a valid chatID from GOSQUARED_CHAT_CHATS or GOSQUARED_CHAT_CHAT actions - The chatID corresponds to the person_id of the visitor Returns: - A list of messages with timestamp, sender, and text content - Cardinality field showing the total message count

Retrieve Event CountsReads only

Retrieve counts of tracked event triggers over a specified time period. Use this tool to analyze how frequently custom events have been triggered on your site. Events must first be tracked using the GoSquared tracking API before they appear in results. Note: The 'data' property passed when tracking events is not included in this endpoint; use the Feed API to access event metadata.

Send Chat Message

Send a message to a visitor in a GoSquared chat conversation. Use this tool to: - Send messages as an agent to website visitors - Send automated bot responses - Send messages on behalf of a client (requires auth signature) Prerequisites: Obtain a valid chatID from GOSQUARED_CHAT_CHATS or GOSQUARED_CHAT_CHAT first. For client messages, generate a Person Signature using SHA-256 HMAC with the Secure Mode Secret.

Send Tracking Ping

Sends a ping to keep the visitor session active in GoSquared. Must be received at least once every 30 seconds to maintain the session, otherwise the session will time out. Use this when implementing custom tracking libraries or advanced tracking processes.

Smart Group PeopleReads only

Retrieve people (user profiles) from a specific Smart Group in GoSquared People CRM. Smart Groups are saved user segments defined by property or event filters. Use this action to list users matching a Smart Group's criteria, with optional search filtering and pagination. Prerequisites: - Requires a valid group_id. Get available Smart Group IDs using the 'List People Smart Groups' action first. - Requires 'read_people' API key scope. Returns user profiles with properties like id, email, name, and any custom properties tracked in People CRM.

Tag Visitor

Tool to add a tag to an identified visitor in GoSquared. Use when you need to categorize, segment, or label visitors for organizational purposes or marketing campaigns.

Timeout Visitor Sessions

Tool to end all tracking sessions for a specified visitor in GoSquared. Use when you need to manually terminate a visitor's session, such as when a user logs out or closes their browser. Optionally specify a page index to timeout only a specific session.

Track GoSquared Event

Track custom events in GoSquared analytics. Use to record user actions like signups, purchases, button clicks, or any custom event. Events are associated with visitors/people and appear in their activity feeds and analytics dashboards.

Track GoSquared Transaction

Track e-commerce transactions in GoSquared analytics. Use this when a customer completes a purchase to record the transaction details including items purchased, revenue, and customer identification. The transaction ID must be unique - GoSquared uses this to prevent duplicate transactions. If the same transaction ID is sent again, the duplicate will be ignored. Transaction data appears in the GoSquared Ecommerce dashboard and can be associated with People profiles for customer analytics.

Track Pageview

Tracks a pageview event in GoSquared Analytics. Use this to record when a visitor views a page on your site. Requires visitor_id (unique identifier for the visitor) and page URL. Optionally include additional visitor data like screen size, browser info, campaign attribution, and more.

Track User Properties

Track user properties for a visitor in GoSquared. Use to set or update profile information for identified users or anonymous visitors. Properties include email, name, company details, and custom fields. Requires either person_id or visitor_id.

Unarchive Chat Conversation

Unarchives a chat conversation in GoSquared Inbox. Use this action to restore an archived chat back to active state, making it visible in the active inbox again. This is useful when you need to resume conversations that were previously archived using the 'Archive Chat Conversation' action or archived manually in the GoSquared interface.

Update Account Blocked Bots

Tool to update the automatic bot blocking feature for a project. Use when you need to enable or disable bot filtering for analytics tracking.

Update Account Blocked IPs

Tool to update the list of IP addresses to be blocked for a GoSquared project. Use when you need to block specific IP addresses from being tracked in analytics.

More in Analytics

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or