Skip to main content
Gosquared logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 90
  • Triggers: 0
  • Slug: GOSQUARED
  • Version: 20261101_00

Tools

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

Input Parameters

string ("admin" | "member")
Role assigned to the user. Accepted values: ‘admin’ or ‘member’.
string
required
Email address of the user to add.
boolean
Whether to send an invite email to the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_ACCOUNT_REMOVE_SHARED_USERRemoves 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.

Input Parameters

string
required
Email address of the shared user to remove from the GoSquared project. The operation is idempotent and will succeed even if the user doesn’t exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_ACCOUNT_SHARED_USERSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("grouped" | "flat")
Response format: ‘grouped’ returns sites organized by ownership (owned vs shared); ‘flat’ returns all accessible sites in a single list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_AUTH_TOKEN_INFOTool to check whether an API key is valid and retrieve its enabled scopes. Use when verifying API credentials before making further API calls.

Input Parameters

string
required
An API Key associated with your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_BLOCK_VISITORTool to block a specific visitor from being tracked. Use when you need to prevent tracking for a particular visitor ID.

Input Parameters

string
required
Unique identifier of the visitor to block.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the chat conversation. This is the same as the person_id of the visitor/client. Can be obtained from GOSQUARED_CHAT_CHATS or GOSQUARED_LIST_PEOPLE actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 count

Input Parameters

string
Pagination control in ‘offset,count’ format. Default ‘0,10’ returns first 10 messages. Use ‘10,10’ for next 10, ‘20,10’ for third page, etc. Maximum count is 250 messages per request.
string
required
The unique ID of the chat conversation. This matches the person_id of the visitor. Obtain from GOSQUARED_CHAT_CHATS or GOSQUARED_CHAT_CHAT actions.
string
Filter messages sent on or before this date-time. Must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Combine with from_date to get messages within a date range.
string
Filter messages sent on or after this date-time. Must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Useful for retrieving messages from a specific time period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_CHAT_CHATSTool to retrieve chat data for reporting purposes. Use when you need to list active chat conversations within a specific time window.

Input Parameters

string
Pagination offset and count, formatted as ‘offset,count’. Max count is 250.
string
End date-time for the query, in ISO 8601 format.
string
Start date-time for the query, in ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination parameter formatted as ‘offset,count’ where offset is the number of items to skip and count is the number of items to return. Maximum count is 250. Default is ‘0,10’ (first 10 items).
string
required
ID of the chat conversation to retrieve feed from. This is the same as the person_id from the People API (e.g., ‘email:user@example.com’, ‘user-123’, or any custom person identifier).
string
Filter feed items to those created on or before this date-time. Use ISO 8601 format with timezone (e.g., ‘2024-12-31T23:59:59Z’). If omitted, no upper date bound is applied.
string
Filter feed items to those created on or after this date-time. Use ISO 8601 format with timezone (e.g., ‘2024-01-01T00:00:00Z’). If omitted, no lower date bound is applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
URL to send webhook notifications to. Must be a valid HTTP/HTTPS endpoint that can receive POST requests.
string
Display name for the webhook to help identify it in the dashboard.
string
Additional value associated with the trigger. Usage depends on the trigger type (e.g., smart group ID for entered_smart_group/exited_smart_group triggers).
string ("chat_message" | "entered_smart_group" | "exited_smart_group" | "traffic_dip" | "traffic_spike")
Enum for webhook trigger types.
boolean
Whether to include unverified events in webhook notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The threshold or value for the trigger. For traffic_spike/traffic_dip, this represents the percentage change (e.g., ‘50’ for 50% spike). For other triggers, refer to API docs for format.
string ("chat_message" | "entered_smart_group" | "exited_smart_group" | "traffic_dip" | "traffic_spike")
required
The type of event that will activate this webhook. Use ‘traffic_spike’ or ‘traffic_dip’ for analytics alerts, or use ‘chat_message’, ‘entered_smart_group’, ‘exited_smart_group’ for other events.
integer
required
The unique ID of the webhook to add the trigger to. Obtain this from the webhook creation endpoint or webhook list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_DELETE_ACCOUNT_WEBHOOKTool to delete a webhook from a GoSquared account. Use when you need to remove an existing webhook by its ID.

Input Parameters

integer
required
The unique identifier of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, blacklist the person’s IDs/emails to block re-creation, outbound sends, and webhooks.
string
required
Unique identifier of the person to delete. Can be the person’s ID or email address prefixed with ‘email:’ (e.g., ‘email:user@example.com’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Page index specification for targeted session timeout.
string
required
The anonymous visitor identifier associated with the action. This is the unique ID used to track the visitor whose sessions should be ended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("plain" | "tags" | "indexedTags")
Modifies the response data structure. Accepted values: ‘plain’ (returns list of IDs), ‘tags’ (returns list of objects with ID and tag), ‘indexedTags’ (returns key-value mapping of ID to tag). Default: ‘plain’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_BLOCKED_BOTSTool to retrieve the bot blocking status for a GoSquared project. Use when you need to check whether automatic bot blocking is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_BLOCKED_IPSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("plain" | "tags" | "indexedTags")
Modifies the response data structure. Accepted values: ‘plain’ (returns list of visitor IDs), ‘tags’ (returns list of objects with visitor ID and tag), ‘indexedTags’ (returns key-value mapping of visitorID to tag). Default: ‘plain’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A valid GoSquared site token identifying the project to retrieve. Site tokens are typically formatted as ‘GSN-XXXXXX-X’ (e.g., ‘GSN-885166-C’). Use the List Account Sites action to discover available site tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_SITES_USAGETool 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.

Input Parameters

string
The end date-time for the query (ISO 8601 format or relative format like ‘now’)
string
The start date-time for the query (ISO 8601 format or relative format like ‘-7d’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum results to return; supports ‘offset,count’ format (e.g., ‘5,10’). Default is ‘0,100’.
string ("plain" | "indexed")
Response format: ‘plain’ returns a list of visitor objects; ‘indexed’ returns a key:value object mapping visitorID to tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The trigger type identifier to retrieve. Common trigger types include: ‘entered_smart_group’ (when a person enters a Smart Group), ‘exited_smart_group’ (when a person exits a Smart Group), ‘traffic_spike’ (when traffic increases significantly), ‘traffic_dip’ (when traffic decreases significantly), ‘chat_message’ (when a chat message is received). Use the Get Account Trigger Types action to discover all available trigger types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_TRIGGER_TYPESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_WEBHOOKTool to retrieve a specific webhook by ID from a GoSquared account. Use when you need to fetch details about an existing webhook configuration.

Input Parameters

integer
required
The unique identifier of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_ACCOUNT_WEBHOOKSRetrieve 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique numeric identifier of the webhook to retrieve triggers for. This ID is obtained when creating a webhook or from the list webhooks endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the chat conversation (same as the person_id of the client/visitor).
string
required
Unique ID of the specific message to retrieve (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Controls result count and pagination. Format: ‘count’ or ‘offset,count’ (e.g., ‘5’ returns first 5 results, ‘5,10’ skips 5 and returns next 10). Default: ‘0,5’.
string ("truncatedList" | "list" | "truncatedObject" | "object")
Modifies the response data structure. Accepted values: ‘truncatedList’ (default) includes ‘other’ sum, ‘list’ shows items only, ‘truncatedObject’ returns key-value object with ‘other’, ‘object’ returns key-value object without truncation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Controls pagination. Format: ‘offset,count’ where offset is the starting position (0-based) and count is the number of results to return. If omitted, returns default number of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum number of results to return; may include offset as ‘offset,count’ (e.g., ‘5,10’). Default is ‘0,5’.
string ("truncatedList" | "list" | "truncatedObject" | "object")
Alters response structure; one of: ‘truncatedList’, ‘list’, ‘truncatedObject’, ‘object’. Default is ‘truncatedList’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_NOW_ENGAGEMENTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Controls pagination and result count. Format: ‘offset,count’ where offset is the starting position (0-based) and count is the number of results to return (e.g., ‘5,10’ returns 10 results starting from position 5). Default: ‘0,30’.
string
Format for returned date fields; accepts any Moment.js format (e.g., ‘YYYY-MM-DD’, ‘MM/DD/YYYY’).
string ("all" | "tagged" | "returning")
Visitor types filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_NOW_LANGUAGESTool to retrieve languages for currently online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor languages.

Input Parameters

string
Maximum number of results to return; may include offset as ‘offset,count’ (e.g., ‘5,10’).
string ("truncatedList" | "list" | "truncatedObject" | "object")
Alters response shape; one of: ‘truncatedList’, ‘list’, ‘truncatedObject’, ‘object’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum number of results to return; supports ‘offset,count’ format (e.g., ‘0,10’ for first 10 results, ‘10,20’ for next 20). Default is ‘0,10’.
string
End date-time for the query range (ISO-8601 or Moment.js-compatible format).
string
Start date-time for the query range (ISO-8601 or Moment.js-compatible format).
string
Output format for date fields following Moment.js documentation standards (e.g., ‘YYYY-MM-DD’, ‘YYYY-MM-DDTHH:mm:ssZ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum number of results to return. Format: “offset,count” (e.g., “0,10” returns first 10 results, “5,5” skips first 5 and returns next 5). Can also specify just count (e.g., “10”). Default: “0,5”.
string ("truncatedList" | "list" | "truncatedObject" | "object")
Response format options for the organisations endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum results per source category. Format: “offset,count” (e.g., “0,10” returns first 10 results). Default: “0,10”.
boolean
If true, returns a compact response with only visitor counts. Default: false.
string ("direct" | "site" | "social" | "organic" | "internal")
required
Source section type to retrieve. Must be one of: direct, site, social, organic, or internal.
string
Maximum drill-down results within each source item. Format: “offset,count” (e.g., “0,5”). Default: “0,5”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Format for the returned time field; accepts any Moment.js format string. For example, ‘YYYY-MM-DD’ returns dates as ‘2024-01-01’, or ‘YYYY-MM-DDTHH:mm:ssZ’ for ISO 8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Number of results to return, with optional offset. Format: ‘offset,count’ (e.g., ‘0,10’ returns first 10, ‘5,10’ skips 5 then returns 10). Default is ‘0,10’ if not specified.
string ("plain" | "events" | "pageEvents")
Response format: ‘plain’ returns minimal visitor data, ‘events’ (default) includes all visitor events, ‘pageEvents’ groups events by page.
string
required
The unique identifier of the visitor to retrieve. Obtain this from the GOSQUARED_NOW_VISITORS action which lists currently online visitors.
string ("all" | "tagged" | "returning")
Filter visitor type: ‘all’ (default) returns all visitors, ‘tagged’ returns only identified/tagged visitors, ‘returning’ returns only returning visitors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_GET_PEOPLE_EVENT_TYPESRetrieve all event types tracked in GoSquared People CRM, ordered by frequency. Use this to discover available events for filtering or building Smart Groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
When True, returns only custom-defined properties (excludes built-in system properties like ‘email’, ‘name’, etc.). When False (default), returns all properties including both system and custom properties.
string
Specific property identifier to fetch (e.g., ‘email’, ‘last.seen’, ‘company.name’). When provided, returns schema details for only that single property. Use dot notation for nested properties (e.g., ‘last.location.city’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the person to retrieve from GoSquared People CRM. This ID is typically obtained from the List People endpoint or from tracking events. Can be a GoSquared-generated ID (e.g., ‘5f8d0c1b2e3a4f5g6h7i8j9k’) or an email-prefixed identifier (e.g., ‘email:user@example.com’) if the person was identified that way.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Sort order, e.g., ‘ts:desc’ (newest first) or ‘ts:asc’.
string
Comma-separated event families to include: ‘event’ for custom events and ‘sessionEvent’ for GoSquared session events.
string
Pagination in the form ‘offset,count’. Offset ≥ 0; count ≤ 250 per request.
string
Search within the person’s event history by event name.
string
End ISO 8601 date-time for the feed filter.
string
required
The unique identifier of the person whose event feed to retrieve. Can be a GoSquared-generated ID (e.g., ‘user-abc-12345’), an email-prefixed identifier (e.g., ‘email:user@example.com’), or any custom ID set during tracking. Obtain from List People action or tracking event responses.
string
Start ISO 8601 date-time for the feed filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2026-02-14’) or ISO 8601 (‘2026-02-14T23:59:59Z’).
string
Time interval for grouping results. Common values include ‘hour’, ‘day’, ‘week’, ‘month’.
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2026-01-01’) or ISO 8601 (‘2026-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2026-01-31), ‘MMMM Do YYYY’ (January 31st 2026).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit in ‘offset,count’ format. For example, ‘0,20’ returns first 20 results, ‘20,10’ skips 20 and returns next 10. Default is ‘0,20’ if not specified.
string ("json" | "csv")
Response format. Use ‘json’ for structured data or ‘csv’ for comma-separated values export.
string
required
End date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-07T23:59:59Z’) or date strings like ‘2024-01-07’.
string
required
Start date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’) or date strings like ‘2024-01-01’.
string
Optional Moment.js format string for formatting date fields in the response (e.g., ‘YYYY-MM-DD’, ‘DD/MM/YYYY’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5). Default is ‘0,20’.
string
required
End date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-31’ or ‘2024-01-31T23:59:59Z’) or simple date strings.
string
required
Start date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’) or simple date strings.
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’ for dates like ‘2024-01-01’).
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, groups results by common source (e.g., by domain for sites, search engine for organic). Default is false.
string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).
string ("site" | "social" | "organic" | "internal")
Filter by specific source category. If omitted, returns all source types (direct, organic, site, social, internal).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Property to sort by with direction suffix ‘:asc’ or ‘:desc’ (default ‘last.seen:desc’).
string
Maximum results to return; may include offset as ‘offset,count’ (e.g., ‘0,10’). Max 250.
string
Free-text search term to filter people profiles.
string
Comma-separated list of fields to return for each person (e.g., ‘id,email’).
array
List of filter objects to apply on properties or events.
string ("plain" | "csv")
Response format: ‘plain’ for JSON array, ‘csv’ for CSV text (default ‘plain’).
string
Moment.js format string for any date fields in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_NOW_CONCURRENTSTool to retrieve the number of concurrent visitors currently on your site. Use when you need live, real-time visitor metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_NOW_PLATFORMSTool to retrieve platforms used by online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor platforms.

Input Parameters

string
Maximum number of results to return; may include offset as ‘offset,count’ (e.g., ‘5,10’).
string ("truncatedList" | "list" | "truncatedObject" | "object")
Alters response shape; one of: ‘truncatedList’, ‘list’, ‘truncatedObject’, ‘object’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_NOW_V3_OVERVIEWTool 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.

Input Parameters

string
End date-time for the query in ISO 8601 or any Moment.js-compatible format.
string
Start date-time for the query in ISO 8601 or any Moment.js-compatible format.
string
Format for returned date fields; accepts any Moment.js format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Maximum results per source category. Format: “offset,count” (e.g., “0,10” returns first 10 results). Default: “0,10”.
boolean
If true, returns a compact response with only visitor counts. Default: false.
string
Comma-separated list of source categories to retrieve. Available values: direct, site, social, organic, internal. Default: “direct,site,social,organic,internal”.
string
Maximum drill-down results within each source item. Format: “offset,count” (e.g., “0,5”). Default: “0,5”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-02T00:00:00Z’) or any Moment.js-compatible format. If omitted, defaults to the current time.
string
Time interval between data points in the format ‘Xmin’ where X is the number of minutes. For example, ‘5min’ returns one data point every 5 minutes. Defaults to ‘5min’.
string
Start date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’) or any Moment.js-compatible format. If omitted, defaults to 24 hours before ‘to_time’.
string
Moment.js format string for date values in the response. For example, ‘YYYY-MM-DD’ returns dates as ‘2024-01-01’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_NOW_VISITORSTool to retrieve a list of current online visitors. Use when you need detailed real-time visitor information.

Input Parameters

string
Maximum results to return; supports ‘offset,count’ (e.g., ‘5,10’).
string
End date-time for the query window (ISO-8601).
string
Start date-time for the query window (ISO-8601).
string
Moment.js format string for returned date fields.
string ("all" | "tagged" | "returning")
Subset of visitors to return; one of ‘all’, ‘tagged’, or ‘returning’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination parameter. Use format ‘count’ for first N items or ‘offset,count’ to skip offset items and return count items. Examples: ‘10’ returns first 10 devices, ‘5,20’ skips 5 and returns next 20. Maximum count per page is 250. Default: ‘0,10’ (first 10 devices).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date-time (ISO 8601 format) to filter the export. When combined with from_date, the range must not exceed 60 days.
string
required
ID of the Smart Group to export. Usually the lowercase name of the Smart Group (e.g., ‘active-users’). Can be found in the URL path when viewing the group in the People dashboard.
string
Start date-time (ISO 8601 format) to filter the export. When combined with to_date, the range must not exceed 60 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Sort order for results in format ‘property:direction’. Direction is ‘asc’ (ascending) or ‘desc’ (descending). Common sort properties: last.seen, first.seen, name, email.
string
Pagination in format ‘offset,count’. Offset is the starting index (0-based), count is the number of results to return (max 250). Example: ‘0,50’ returns first 50 results, ‘50,50’ returns next 50.
string
Optional search term to filter people within the Smart Group by name, email, or other indexed properties.
string
Comma-separated list of specific person properties to return. If not specified, returns all available properties. Common fields: id, email, name, last.seen, first.seen, avatar.
string
required
The unique identifier of the Smart Group. Usually the lowercase name of the group (e.g., ‘active-users’, ‘new-signups’). Can be found in the URL when viewing the Smart Group in the People dashboard, or retrieved via the List Smart Groups action.
string ("plain" | "csv")
Response format. ‘plain’ returns JSON array of person objects. ‘csv’ returns data as CSV text for export.
string
Optional Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’, ‘MM/DD/YYYY HH:mm’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOSQUARED_POST_ACCOUNT_SITESCreate 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.

Input Parameters

string
required
Publicly accessible site URL to track (must start with http:// or https://).
string
Display name for the new site (optional).
string
IANA timezone for the site (server default: Europe/London).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the chat conversation to archive. In GoSquared, chat IDs are the same as person IDs. This ID can be obtained from the ‘id’ field returned by the ‘Retrieve Chat Conversations’ (GOSQUARED_CHAT_CHATS) action, ‘List People’ (GOSQUARED_LIST_PEOPLE) action, or from the chat feed. Supports various formats including email-based IDs (e.g., ‘email:user@example.com’) and custom identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Person Signature (SHA-256 HMAC) for authenticating client messages. Required only when sender=‘client’. Generate using the visitor’s ID and your project’s Secure Mode Secret.
string
required
The unique ID of the chat conversation. This is the same as the person_id of the visitor/client. Obtain this from GOSQUARED_CHAT_CHATS action.
string ("agent" | "client" | "bot")
Who is sending the message. Use ‘agent’ for support staff messages (default), ‘bot’ for automated responses, or ‘client’ for visitor messages (requires auth).
string
required
The text content of the message to send.
integer
Unix epoch timestamp (seconds) for the message. Defaults to current time if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the chat conversation (same as the person_id of the client).
string ("agent" | "client" | "bot")
Sender type of the note. Accepted values: ‘agent’, ‘client’, or ‘bot’.
string
required
The text content of the note.
integer
Unix timestamp of the note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the chat conversation to unarchive. In GoSquared, chat IDs are the same as person IDs. This ID can be obtained from the ‘id’ field returned by the ‘Retrieve Chat Conversations’ (GOSQUARED_CHAT_CHATS) action, ‘List People’ (GOSQUARED_LIST_PEOPLE) action, or from the chat feed. Supports various formats including email-based IDs (e.g., ‘email:user@example.com’) and custom identifiers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 analysis

Input Parameters

string
required
Name of the Smart Group
object
Optional preferences for the Smart Group
array
required
List of filter objects defining group membership
string ("asc" | "desc")
Sort direction, either ‘asc’ or ‘desc’
string
Field to sort members by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Page information for the ping, including the page index and optionally the engaged time in milliseconds.
string
required
The anonymous visitor ID associated with this action. Use a consistent ID across the session to track the same visitor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The tag to attach to the visitor. Used for segmenting and organizing visitors.
string
required
The unique identifier of the visitor to tag. This is the visitor ID tracked by GoSquared.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Visitor’s IP address used for geolocation detection.
object
Page context where the event occurred. Keys: url (string), title (string), previous (int - index of previous page), index (int).
object
required
The event to track. Must include a ‘name’ field. Can optionally include ‘data’ for metadata and ‘timestamp’ for when it occurred.
object
Aggregate visitor statistics. Keys: visits (int), pageviews (int).
object
Visitor’s screen properties. Keys: height (int), width (int), pixel_ratio (float), depth (int - color depth).
object
Marketing campaign attribution data. Keys: name, source, medium, content, term (all strings).
string
Language setting of the visitor’s browser (BCP 47 format).
object
Location context. Keys: timezone_offset (int - minutes from UTC).
string
Referrer URL that brought the visitor to the current page.
string
Unique identifier for a known person in GoSquared People CRM. Prefix email addresses with ‘email:’ (e.g., ‘email:user@example.com’).
boolean
Whether this visitor has visited before (True) or is new (False).
string
User agent string from the visitor’s browser for device/browser detection.
string
Anonymous visitor identifier. Use to track events for visitors who haven’t been identified yet.
string
Character encoding of the visitor’s browser.
string
ISO 8601 timestamp of the visitor’s last pageview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier for the person. Use ‘email:’ prefix for email-based identification (e.g., ‘email:user@example.com’) or provide a custom ID string.
object
Custom properties to set on the person’s profile. Reserved keys include: name, email, username, phone, created_at, company_name, company_industry, company_size. Custom properties become filterable in the People dashboard.
string
Anonymous visitor ID to merge with this person’s profile. Used to link previous anonymous browsing activity to the identified user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Visitor IP address (used for geolocation)
object
required
Information about the page being viewed
object
Aggregate visit and pageview counts for the visitor.
object
Screen properties of the visitor.
object
Campaign data for pageview.
string
Browser language
object
Visitor location information.
string
Referrer URL
boolean
Whether the visitor has returned before
string
ISO 8601 timestamp of this pageview
string
Browser user-agent string
string
required
Unique identifier for the anonymous visitor. Use a consistent ID across sessions to track the same visitor over time.
string
Browser character set
string
ISO 8601 timestamp of last pageview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Visitor’s IP address for geolocation detection.
object
Page context where the transaction occurred. Keys: ‘url’ (string), ‘title’ (string), ‘previous’ (number, page index), ‘index’ (number), ‘referrer’ (string).
object
Session totals. Keys: ‘visits’ (number of visits), ‘pageviews’ (total pageviews).
object
Visitor’s screen information. Keys: ‘height’, ‘width’, ‘pixel_ratio’, ‘depth’.
object
Marketing campaign attribution data. Keys: ‘name’, ‘source’, ‘medium’, ‘content’, ‘term’.
string
Language setting of the visitor’s browser (e.g., ‘en-US’).
object
Location context. Keys: ‘timezone_offset’ (minutes from UTC).
string
People CRM person ID to associate with this transaction. Prefix with ‘email:’ when using an email address (e.g., ‘email:customer@example.com’).
boolean
Whether this visitor is a returning customer.
string
ISO 8601 timestamp of when the transaction occurred. Defaults to current time if not specified.
string
User agent string of the visitor’s browser.
string
Anonymous visitor ID to associate with this transaction. Use this to link the transaction to a browser session.
object
required
Transaction payload. Required keys: ‘id’ (unique transaction identifier), ‘items’ (array of purchased products). Optional keys: ‘revenue’ (total amount, defaults to sum of item revenues), ‘quantity’ (total units, defaults to sum of item quantities), ‘previous_transaction_timestamp’ (ISO 8601 timestamp of customer’s last purchase). Each item should have: ‘name’, ‘price’, ‘quantity’, ‘categories’ (array).
string
Character set of the visitor’s browser (e.g., ‘UTF-8’).
string
ISO 8601 timestamp of the visitor’s last pageview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Full name of the person
string
Email address of the person
string
Phone number of the person
string
URL of an avatar image for this person
object
Custom properties with automatic type detection (Text, Number, Date, Boolean, or Null). Maximum 1000 custom properties per project; excess properties are ignored.
string
Current status of the person
object
Company information for a person.
string
Username of the person
string
Last name of the person
string
Unique identifier for the person in People CRM. Prefix email addresses with ‘email:’ for email-based identification (e.g., ‘email:user@example.com’). Either person_id or visitor_id must be provided.
string
ISO 8601 timestamp when the person was created
string
First name of the person
string
Anonymous visitor identifier. Use to track properties for visitors who haven’t been identified yet. Either person_id or visitor_id must be provided.
string
Biography or description of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit in ‘offset,count’ format. For example, ‘0,20’ returns the first 20 results, ‘20,10’ skips 20 and returns the next 10. Default is ‘0,20’ if not specified.
string ("json" | "csv")
Response format. Use ‘json’ for structured data (default) or ‘csv’ for comma-separated values export.
string
required
End date-time for the analytics query in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). This is required.
string ("hour" | "day" | "month")
Time interval for grouping/aggregating data points. Use ‘hour’ for hourly breakdown, ‘day’ for daily (default), or ‘month’ for monthly aggregation.
string
required
Start date-time for the analytics query in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). This is required.
string
Optional Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’ for dates like ‘2024-01-01’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Limit results with optional offset,count notation (e.g., ‘0,20’ for first 20 results, ‘5,10’ for 10 results starting at offset 5).
string
required
End date for the query in ISO 8601 format (e.g., ‘2024-01-07’ or ‘2024-01-07T23:59:59Z’).
string
required
Start date for the query in ISO 8601 format (e.g., ‘2024-01-01’ or ‘2024-01-01T00:00:00Z’).
string
Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’).
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit in ‘offset,count’ format. For example, ‘0,20’ returns first 20 results, ‘20,10’ skips 20 and returns next 10. Default is ‘0,20’ if not specified.
string ("json" | "csv")
Response format. Use ‘json’ for structured data or ‘csv’ for comma-separated values export.
string
required
End date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-07T23:59:59Z’) or date strings like ‘2024-01-07’.
string
required
Start date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’) or date strings like ‘2024-01-01’.
string
Optional Moment.js format string for formatting date fields in the response (e.g., ‘YYYY-MM-DD’, ‘DD/MM/YYYY’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination limit as ‘offset,count’. Offset is starting position (0-indexed), count is number of results. Default is ‘0,20’.
string ("json" | "csv")
Response format: ‘json’ (default) returns structured data, ‘csv’ returns comma-separated values.
string
required
End date-time for the query. Accepts various formats including simple dates (‘2024-01-31’) or ISO 8601 (‘2024-01-31T23:59:59Z’).
string
required
Start date-time for the query. Accepts various formats including simple dates (‘2024-01-01’) or ISO 8601 (‘2024-01-01T00:00:00Z’).
string
Moment.js format string for dates in the response. Common formats: ‘YYYY-MM-DD’ (2024-01-31), ‘MMMM Do YYYY’ (January 31st 2024).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Pagination control as ‘offset,count’. Default is ‘0,20’ (first 20 results). Use ‘10,50’ to skip 10 and return 50 results.
string ("json" | "csv")
Response format. Use ‘json’ for structured data (default) or ‘csv’ for comma-separated values export.
string
required
End date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-07T23:59:59Z’) or simple date format (e.g., ‘2024-01-07’).
string
required
Start date-time for the query. Accepts ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’) or simple date format (e.g., ‘2024-01-01’).
string
Optional Moment.js format string for date fields in the response (e.g., ‘YYYY-MM-DD’, ‘MMM D, YYYY’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether to block bots or not. Set to true to enable automatic bot blocking, false to disable it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
IP address(es) to block. For multiple IPs, separate with commas (e.g., ‘192.0.2.1,192.0.2.2’). Supports individual IPs, CIDR ranges, and pattern matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not