- Category: analytics
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 90
- Triggers: 0
- Slug:
GOSQUARED - Version: 20261101_00
Tools
List Account Sites
List Account Sites
GOSQUARED_ACCOUNT_SITESList 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.Input Parameters
Output
Check API Token Validity and Scopes
Check API Token Validity and Scopes
Block Visitor
Block Visitor
Retrieve Chat Conversation
Retrieve Chat Conversation
GOSQUARED_CHAT_CHATRetrieve 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.Input Parameters
Output
Retrieve Chat Messages
Retrieve Chat Messages
GOSQUARED_CHAT_CHAT_MESSAGESRetrieve 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 countInput Parameters
Output
Retrieve Chat Conversations
Retrieve Chat Conversations
Retrieve Chat Feed
Retrieve Chat Feed
GOSQUARED_CHAT_FEEDRetrieve a chat conversation’s feed of messages and events by chat ID. Supports pagination and date filtering for portions of the conversation history.Input Parameters
Output
Create Account Webhook
Create Account Webhook
GOSQUARED_CREATE_ACCOUNT_WEBHOOKTool 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.Input Parameters
Output
Create Webhook Trigger
Create Webhook Trigger
GOSQUARED_CREATE_WEBHOOK_TRIGGERTool 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.Input Parameters
Output
Delete Account Webhook
Delete Account Webhook
Delete person
Delete person
GOSQUARED_DELETE_PERSONTool to delete a person profile and all associated data. Use when you need to permanently remove a person’s record and optionally blacklist them.Input Parameters
Output
Timeout Visitor Sessions
Timeout Visitor Sessions
GOSQUARED_END_VISITOR_SESSIONSTool 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.Input Parameters
Output
Get Account Blocked Items
Get Account Blocked Items
GOSQUARED_GET_ACCOUNT_BLOCKEDTool 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.Input Parameters
Output
Get Account Blocked Bots
Get Account Blocked Bots
Get Blocked IP Addresses
Get Blocked IP Addresses
Get Account Blocked Visitors
Get Account Blocked Visitors
GOSQUARED_GET_ACCOUNT_BLOCKED_VISITORSTool 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).Input Parameters
Output
Get Account Site Details
Get Account Site Details
GOSQUARED_GET_ACCOUNT_SITETool 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.Input Parameters
Output
Get Account Sites Usage
Get Account Sites Usage
Get Account Tagged Visitors
Get Account Tagged Visitors
GOSQUARED_GET_ACCOUNT_TAGGED_VISITORSTool 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.Input Parameters
Output
Get Account Trigger Type
Get Account Trigger Type
GOSQUARED_GET_ACCOUNT_TRIGGER_TYPETool 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.Input Parameters
Output
Get Account Trigger Types
Get Account Trigger Types
Get Account Webhook
Get Account Webhook
Get Account Webhooks
Get Account Webhooks
Get Account Webhook Triggers
Get Account Webhook Triggers
GOSQUARED_GET_ACCOUNT_WEBHOOK_TRIGGERSRetrieve the triggers configured for a webhook by its numeric ID. Use this to see which events are configured to fire the webhook.Input Parameters
Output
Get Specific Chat Message
Get Specific Chat Message
GOSQUARED_GET_CHAT_CHAT_MESSAGERetrieve 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).Input Parameters
Output
Get Real-Time Visitor Browsers
Get Real-Time Visitor Browsers
GOSQUARED_GET_NOW_BROWSERSTool 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.Input Parameters
Output
Get Real-Time Campaigns
Get Real-Time Campaigns
GOSQUARED_GET_NOW_CAMPAIGNSTool 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.Input Parameters
Output
Get Real-Time Visitor Countries
Get Real-Time Visitor Countries
GOSQUARED_GET_NOW_COUNTRIESTool 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.Input Parameters
Output
Get Real-Time Engagement
Get Real-Time Engagement
Get Real-Time Visitor Geo Locations
Get Real-Time Visitor Geo Locations
GOSQUARED_GET_NOW_GEOTool 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.Input Parameters
Output
Get Real-Time Visitor Languages
Get Real-Time Visitor Languages
Get Now Notifications
Get Now Notifications
GOSQUARED_GET_NOW_NOTIFICATIONSTool to retrieve notifications stored in GoSquared. Use when you need to access Traffic Alerts, RSS feed items, or Milestones.Input Parameters
Output
Get Real-Time Organisations
Get Real-Time Organisations
GOSQUARED_GET_NOW_ORGANISATIONSTool 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.Input Parameters
Output
Get Now Sources By Section
Get Now Sources By Section
GOSQUARED_GET_NOW_SOURCES_BY_SECTIONTool 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.Input Parameters
Output
Get Current Time
Get Current Time
GOSQUARED_GET_NOW_TIMETool to retrieve the current time according to GoSquared infrastructure. Use when you need a synchronized timestamp from GoSquared’s servers.Input Parameters
Output
Get Specific Visitor
Get Specific Visitor
GOSQUARED_GET_NOW_VISITORRetrieves 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.Input Parameters
Output
Get People Event Types
Get People Event Types
Get People Property Types
Get People Property Types
GOSQUARED_GET_PEOPLE_PROPERTY_TYPESRetrieve 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’).Input Parameters
Output
Get Person Profile
Get Person Profile
GOSQUARED_GET_PERSONRetrieve 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.Input Parameters
Output
GoSquared - Get Person Feed
GoSquared - Get Person Feed
GOSQUARED_GET_PERSON_FEEDRetrieve 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.Input Parameters
Output
Get Browser Metrics
Get Browser Metrics
GOSQUARED_GET_TRENDS_BROWSERTool 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.Input Parameters
Output
Get Campaign Content Metrics
Get Campaign Content Metrics
GOSQUARED_GET_TRENDS_CAMPAIGN_CONTENTRetrieve 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.Input Parameters
Output
Get Campaign Name Metrics
Get Campaign Name Metrics
GOSQUARED_GET_TRENDS_CAMPAIGN_NAMERetrieve 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.Input Parameters
Output
Get Campaign Source Metrics
Get Campaign Source Metrics
GOSQUARED_GET_TRENDS_CAMPAIGN_SOURCERetrieve 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.Input Parameters
Output
Get Campaign Term Metrics
Get Campaign Term Metrics
GOSQUARED_GET_TRENDS_CAMPAIGN_TERMRetrieve 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.Input Parameters
Output
Get Category Metrics
Get Category Metrics
GOSQUARED_GET_TRENDS_CATEGORYTool to retrieve summarised category metrics over a specified time period. Use when analyzing which content categories were accessed during a specific date range.Input Parameters
Output
Get Country Metrics
Get Country Metrics
GOSQUARED_GET_TRENDS_COUNTRYRetrieve 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.Input Parameters
Output
Get Language Metrics
Get Language Metrics
GOSQUARED_GET_TRENDS_LANGUAGERetrieve 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.Input Parameters
Output
Get Organisation Metrics
Get Organisation Metrics
GOSQUARED_GET_TRENDS_ORGANISATIONTool 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.Input Parameters
Output
Get Operating System Metrics
Get Operating System Metrics
GOSQUARED_GET_TRENDS_OSTool 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.Input Parameters
Output
Get Product Metrics
Get Product Metrics
GOSQUARED_GET_TRENDS_PRODUCTTool 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.Input Parameters
Output
Get Screen Dimensions Metrics
Get Screen Dimensions Metrics
GOSQUARED_GET_TRENDS_SCREEN_DIMENSIONSTool 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.Input Parameters
Output
Get Traffic Sources Metrics
Get Traffic Sources Metrics
GOSQUARED_GET_TRENDS_SOURCESTool 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.Input Parameters
Output
Get Trends Sources By Type
Get Trends Sources By Type
GOSQUARED_GET_TRENDS_SOURCES_BY_TYPETool 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.Input Parameters
Output
Get Transaction Metrics
Get Transaction Metrics
GOSQUARED_GET_TRENDS_TRANSACTIONTool to retrieve summarised transaction metrics over a specified time period. Use when analyzing transaction data including revenue and quantity during a specific date range.Input Parameters
Output
List People
List People
GOSQUARED_LIST_PEOPLESearch 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.Input Parameters
Output
Get current concurrent visitors
Get current concurrent visitors
Get Real-Time Popular Pages
Get Real-Time Popular Pages
GOSQUARED_NOW_PAGESRetrieve 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.Input Parameters
Output
Get Real-Time Visitor Platforms
Get Real-Time Visitor Platforms
Get Real-Time Overview
Get Real-Time Overview
Now Sources
Now Sources
GOSQUARED_NOW_V3_SOURCESTool 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.Input Parameters
Output
Get Visitor Time Series
Get Visitor Time Series
GOSQUARED_NOW_V3_TIME_SERIESRetrieves 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.Input Parameters
Output
Get Real-Time Online Visitors
Get Real-Time Online Visitors
GoSquared - List All Devices
GoSquared - List All Devices
GOSQUARED_PEOPLE_DEVICESRetrieve 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.Input Parameters
Output
Export Smart Group Feed
Export Smart Group Feed
GOSQUARED_PEOPLE_SMARTGROUP_FEEDExport 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.Input Parameters
Output
Smart Group People
Smart Group People
GOSQUARED_PEOPLE_SMARTGROUP_PEOPLERetrieve 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.Input Parameters
Output
List People Smart Groups
List People Smart Groups
GOSQUARED_PEOPLE_SMART_GROUPSRetrieve 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.Output
Add Account Site
Add Account Site
Archive Chat Conversation
Archive Chat Conversation
GOSQUARED_POST_CHAT_CHAT_ARCHIVEArchives 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.Input Parameters
Output
Send Chat Message
Send Chat Message
GOSQUARED_POST_CHAT_CHAT_MESSAGESend 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.Input Parameters
Output
Leave Chat Note
Leave Chat Note
GOSQUARED_POST_CHAT_CHAT_NOTEAdds 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.Input Parameters
Output
Unarchive Chat Conversation
Unarchive Chat Conversation
GOSQUARED_POST_CHAT_CHAT_UNARCHIVEUnarchives 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.Input Parameters
Output
Create People SmartGroup
Create People SmartGroup
GOSQUARED_POST_PEOPLE_SMARTGROUPSCreate 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 analysisInput Parameters
Output
Send Tracking Ping
Send Tracking Ping
GOSQUARED_SEND_TRACKING_PINGSends 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.Input Parameters
Output
Tag Visitor
Tag Visitor
GOSQUARED_TAG_VISITORTool 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.Input Parameters
Output
Track GoSquared Event
Track GoSquared Event
GOSQUARED_TRACKING_EVENTTrack 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.Input Parameters
Output
Identify User
Identify User
GOSQUARED_TRACKING_IDENTIFYIdentify 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.Input Parameters
Output
Track Pageview
Track Pageview
GOSQUARED_TRACKING_PAGEVIEWTracks 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.Input Parameters
Output
Track GoSquared Transaction
Track GoSquared Transaction
GOSQUARED_TRACKING_TRANSACTIONTrack 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.Input Parameters
Output
Track User Properties
Track User Properties
GOSQUARED_TRACK_PROPERTIESTrack 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.Input Parameters
Output
Retrieve Aggregate Metrics
Retrieve Aggregate Metrics
GOSQUARED_TRENDS_AGGREGATERetrieve 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.Input Parameters
Output
Get Campaign Medium Metrics
Get Campaign Medium Metrics
GOSQUARED_TRENDS_CAMPAIGN_MEDIUMRetrieve 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.Input Parameters
Output
Retrieve Event Counts
Retrieve Event Counts
GOSQUARED_TRENDS_EVENTRetrieve 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.Input Parameters
Output
Get Page Metrics
Get Page Metrics
GOSQUARED_TRENDS_PAGERetrieve 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.Input Parameters
Output
Get Base Path Metrics
Get Base Path Metrics
GOSQUARED_TRENDS_PATH1Retrieves 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.Input Parameters
Output
Update Account Blocked Bots
Update Account Blocked Bots
GOSQUARED_UPDATE_ACCOUNT_BLOCKED_BOTSTool to update the automatic bot blocking feature for a project. Use when you need to enable or disable bot filtering for analytics tracking.Input Parameters
Output
Update Account Blocked IPs
Update Account Blocked IPs
GOSQUARED_UPDATE_ACCOUNT_BLOCKED_IPSTool 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.