# Gosquared

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

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 90
- **Triggers:** 0
- **Slug:** `GOSQUARED`
- **Version:** 20260227_00

## Tools

### Add Shared User

**Slug:** `GOSQUARED_ACCOUNT_ADD_SHARED_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("admin" | "member") | No | Role assigned to the user. Accepted values: 'admin' or 'member'. |
| `email` | string | Yes | Email address of the user to add. |
| `notify` | boolean | No | Whether to send an invite email to the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove shared user

**Slug:** `GOSQUARED_ACCOUNT_REMOVE_SHARED_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Account Shared Users

**Slug:** `GOSQUARED_ACCOUNT_SHARED_USERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Sites

**Slug:** `GOSQUARED_ACCOUNT_SITES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `presenter` | string ("grouped" | "flat") | No | Response format: 'grouped' returns sites organized by ownership (owned vs shared); 'flat' returns all accessible sites in a single list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check API Token Validity and Scopes

**Slug:** `GOSQUARED_AUTH_TOKEN_INFO`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key` | string | Yes | An API Key associated with your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Block Visitor

**Slug:** `GOSQUARED_BLOCK_VISITOR`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `visitor_id` | string | Yes | Unique identifier of the visitor to block. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Chat Conversation

**Slug:** `GOSQUARED_CHAT_CHAT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatID` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Chat Messages

**Slug:** `GOSQUARED_CHAT_CHAT_MESSAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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. |
| `chatID` | string | Yes | 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. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Chat Conversations

**Slug:** `GOSQUARED_CHAT_CHATS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Pagination offset and count, formatted as 'offset,count'. Max count is 250. |
| `to_date` | string | No | End date-time for the query, in ISO 8601 format. |
| `from_date` | string | No | Start date-time for the query, in ISO 8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Chat Feed

**Slug:** `GOSQUARED_CHAT_FEED`

Retrieve the complete feed of messages and events from a chat conversation. Use this action to: - Fetch chat history and conversation timeline for a specific person - Review messages exchanged between agents, bots, and visitors - Access internal/private agent notes and public messages - Track chat events like archiving, status changes, etc. - Retrieve messages with rich content including emojis and Unicode text The chat_id corresponds to a person_id from the GoSquared People API. You can obtain valid person_id values by first calling the List People action. Supports pagination and date filtering to retrieve specific portions of the chat history. Feed items are typically returned in reverse chronological order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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). |
| `chat_id` | string | Yes | 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). |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Account Webhook

**Slug:** `GOSQUARED_CREATE_ACCOUNT_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | URL to send webhook notifications to. Must be a valid HTTP/HTTPS endpoint that can receive POST requests. |
| `name` | string | No | Display name for the webhook to help identify it in the dashboard. |
| `value` | string | No | 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). |
| `trigger` | string ("chat_message" | "entered_smart_group" | "exited_smart_group" | "traffic_dip" | "traffic_spike") | No | Enum for webhook trigger types. |
| `include_unverified` | boolean | No | Whether to include unverified events in webhook notifications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook Trigger

**Slug:** `GOSQUARED_CREATE_WEBHOOK_TRIGGER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | 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. |
| `trigger` | string ("chat_message" | "entered_smart_group" | "exited_smart_group" | "traffic_dip" | "traffic_spike") | Yes | 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. |
| `webhookID` | integer | Yes | The unique ID of the webhook to add the trigger to. Obtain this from the webhook creation endpoint or webhook list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Account Webhook

**Slug:** `GOSQUARED_DELETE_ACCOUNT_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | The unique identifier of the webhook to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete person

**Slug:** `GOSQUARED_DELETE_PERSON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `blacklist` | boolean | No | If true, blacklist the person's IDs/emails to block re-creation, outbound sends, and webhooks. |
| `person_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Timeout Visitor Sessions

**Slug:** `GOSQUARED_END_VISITOR_SESSIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | object | No | Page index specification for targeted session timeout. |
| `visitor_id` | string | Yes | The anonymous visitor identifier associated with the action. This is the unique ID used to track the visitor whose sessions should be ended. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Blocked Items

**Slug:** `GOSQUARED_GET_ACCOUNT_BLOCKED`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `presenter` | string ("plain" | "tags" | "indexedTags") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Blocked Bots

**Slug:** `GOSQUARED_GET_ACCOUNT_BLOCKED_BOTS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blocked IP Addresses

**Slug:** `GOSQUARED_GET_ACCOUNT_BLOCKED_IPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Blocked Visitors

**Slug:** `GOSQUARED_GET_ACCOUNT_BLOCKED_VISITORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `presenter` | string ("plain" | "tags" | "indexedTags") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Site Details

**Slug:** `GOSQUARED_GET_ACCOUNT_SITE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_token` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Sites Usage

**Slug:** `GOSQUARED_GET_ACCOUNT_SITES_USAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | The end date-time for the query (ISO 8601 format or relative format like 'now') |
| `from` | string | No | The start date-time for the query (ISO 8601 format or relative format like '-7d') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Tagged Visitors

**Slug:** `GOSQUARED_GET_ACCOUNT_TAGGED_VISITORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum results to return; supports 'offset,count' format (e.g., '5,10'). Default is '0,100'. |
| `presenter` | string ("plain" | "indexed") | No | Response format: 'plain' returns a list of visitor objects; 'indexed' returns a key:value object mapping visitorID to tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Trigger Type

**Slug:** `GOSQUARED_GET_ACCOUNT_TRIGGER_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trigger_type` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Trigger Types

**Slug:** `GOSQUARED_GET_ACCOUNT_TRIGGER_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Webhook

**Slug:** `GOSQUARED_GET_ACCOUNT_WEBHOOK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | The unique identifier of the webhook to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Webhooks

**Slug:** `GOSQUARED_GET_ACCOUNT_WEBHOOKS`

Retrieves a list of webhooks configured for the GoSquared project. Returns webhook details including ID, URL, event type, and active status. Use this to audit configured webhooks or verify webhook integrations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Webhook Triggers

**Slug:** `GOSQUARED_GET_ACCOUNT_WEBHOOK_TRIGGERS`

Retrieves all triggers for a webhook. Use when you need to view which events are configured to fire a specific webhook.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Chat Message

**Slug:** `GOSQUARED_GET_CHAT_CHAT_MESSAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chat_id` | string | Yes | ID of the chat conversation (same as the person_id of the client/visitor). |
| `message_id` | string | Yes | Unique ID of the specific message to retrieve (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Visitor Browsers

**Slug:** `GOSQUARED_GET_NOW_BROWSERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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'. |
| `presenter` | string ("truncatedList" | "list" | "truncatedObject" | "object") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Campaigns

**Slug:** `GOSQUARED_GET_NOW_CAMPAIGNS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Visitor Countries

**Slug:** `GOSQUARED_GET_NOW_COUNTRIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum number of results to return; may include offset as 'offset,count' (e.g., '5,10'). Default is '0,5'. |
| `presenter` | string ("truncatedList" | "list" | "truncatedObject" | "object") | No | Alters response structure; one of: 'truncatedList', 'list', 'truncatedObject', 'object'. Default is 'truncatedList'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Engagement

**Slug:** `GOSQUARED_GET_NOW_ENGAGEMENT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Visitor Geo Locations

**Slug:** `GOSQUARED_GET_NOW_GEO`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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'. |
| `dateFormat` | string | No | Format for returned date fields; accepts any Moment.js format (e.g., 'YYYY-MM-DD', 'MM/DD/YYYY'). |
| `visitorsMode` | string ("all" | "tagged" | "returning") | No | Visitor types filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Visitor Languages

**Slug:** `GOSQUARED_GET_NOW_LANGUAGES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum number of results to return; may include offset as 'offset,count' (e.g., '5,10'). |
| `presenter` | string ("truncatedList" | "list" | "truncatedObject" | "object") | No | Alters response shape; one of: 'truncatedList', 'list', 'truncatedObject', 'object'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Now Notifications

**Slug:** `GOSQUARED_GET_NOW_NOTIFICATIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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'. |
| `to_date` | string | No | End date-time for the query range (ISO-8601 or Moment.js-compatible format). |
| `from_date` | string | No | Start date-time for the query range (ISO-8601 or Moment.js-compatible format). |
| `dateFormat` | string | No | Output format for date fields following Moment.js documentation standards (e.g., 'YYYY-MM-DD', 'YYYY-MM-DDTHH:mm:ssZ'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Organisations

**Slug:** `GOSQUARED_GET_NOW_ORGANISATIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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". |
| `presenter` | string ("truncatedList" | "list" | "truncatedObject" | "object") | No | Response format options for the organisations endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Now Sources By Section

**Slug:** `GOSQUARED_GET_NOW_SOURCES_BY_SECTION`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Time

**Slug:** `GOSQUARED_GET_NOW_TIME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dateFormat` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Visitor

**Slug:** `GOSQUARED_GET_NOW_VISITOR`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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. |
| `presenter` | string ("plain" | "events" | "pageEvents") | No | Response format: 'plain' returns minimal visitor data, 'events' (default) includes all visitor events, 'pageEvents' groups events by page. |
| `visitorID` | string | Yes | The unique identifier of the visitor to retrieve. Obtain this from the GOSQUARED_NOW_VISITORS action which lists currently online visitors. |
| `visitorsMode` | string ("all" | "tagged" | "returning") | No | Filter visitor type: 'all' (default) returns all visitors, 'tagged' returns only identified/tagged visitors, 'returning' returns only returning visitors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Event Types

**Slug:** `GOSQUARED_GET_PEOPLE_EVENT_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Property Types

**Slug:** `GOSQUARED_GET_PEOPLE_PROPERTY_TYPES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_only` | boolean | No | 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. |
| `property_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Person Profile

**Slug:** `GOSQUARED_GET_PERSON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GoSquared - Get Person Feed

**Slug:** `GOSQUARED_GET_PERSON_FEED`

Retrieve a person's complete event feed from GoSquared People CRM. Returns a chronologically ordered list of all events (custom events and session events) for a specific person. Use this tool to: - View a person's activity history and engagement timeline - Track specific events by name using the query parameter - Filter by event type (custom events vs session events) - Paginate through large event histories Prerequisites: - Requires a valid personID (obtain from List People or tracking events) - API key must have 'read_people' scope

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order, e.g., 'ts:desc' (newest first) or 'ts:asc'. |
| `type` | string | No | Comma-separated event families to include: 'event' for custom events and 'sessionEvent' for GoSquared session events. |
| `limit` | string | No | Pagination in the form 'offset,count'. Offset ≥ 0; count ≤ 250 per request. |
| `query` | string | No | Search within the person's event history by event name. |
| `to_time` | string | No | End ISO 8601 date-time for the feed filter. |
| `personID` | string | Yes | 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. |
| `from_time` | string | No | Start ISO 8601 date-time for the feed filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Browser Metrics

**Slug:** `GOSQUARED_GET_TRENDS_BROWSER`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Content Metrics

**Slug:** `GOSQUARED_GET_TRENDS_CAMPAIGN_CONTENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Name Metrics

**Slug:** `GOSQUARED_GET_TRENDS_CAMPAIGN_NAME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `dateFormat` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Source Metrics

**Slug:** `GOSQUARED_GET_TRENDS_CAMPAIGN_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Term Metrics

**Slug:** `GOSQUARED_GET_TRENDS_CAMPAIGN_TERM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category Metrics

**Slug:** `GOSQUARED_GET_TRENDS_CATEGORY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country Metrics

**Slug:** `GOSQUARED_GET_TRENDS_COUNTRY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Language Metrics

**Slug:** `GOSQUARED_GET_TRENDS_LANGUAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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. |
| `format` | string ("json" | "csv") | No | Response format. Use 'json' for structured data or 'csv' for comma-separated values export. |
| `to_date` | string | Yes | End date-time for the query. Accepts ISO 8601 format (e.g., '2024-01-07T23:59:59Z') or date strings like '2024-01-07'. |
| `from_date` | string | Yes | Start date-time for the query. Accepts ISO 8601 format (e.g., '2024-01-01T00:00:00Z') or date strings like '2024-01-01'. |
| `dateFormat` | string | No | Optional Moment.js format string for formatting date fields in the response (e.g., 'YYYY-MM-DD', 'DD/MM/YYYY'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organisation Metrics

**Slug:** `GOSQUARED_GET_TRENDS_ORGANISATION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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'. |
| `to_date` | string | Yes | 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. |
| `from_date` | string | Yes | 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. |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD' for dates like '2024-01-01'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) returns structured data, 'csv' returns comma-separated values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Operating System Metrics

**Slug:** `GOSQUARED_GET_TRENDS_OS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Metrics

**Slug:** `GOSQUARED_GET_TRENDS_PRODUCT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Screen Dimensions Metrics

**Slug:** `GOSQUARED_GET_TRENDS_SCREEN_DIMENSIONS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Sources Metrics

**Slug:** `GOSQUARED_GET_TRENDS_SOURCES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trends Sources By Type

**Slug:** `GOSQUARED_GET_TRENDS_SOURCES_BY_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group` | boolean | No | If true, groups results by common source. Behavior varies by sourceType: site groups by domain, organic by search engine, social by domain. Default is false. |
| `limit` | string | No | Pagination limit as 'offset,count'. Offset is starting position (0-indexed), count is number of results. Default is '0,20'. |
| `format` | string ("json" | "csv") | No | Response format: 'json' (default) returns structured data, 'csv' returns comma-separated values. |
| `to_date` | string | Yes | End date-time for the query. Accepts various formats including simple dates ('2024-01-31') or ISO 8601 ('2024-01-31T23:59:59Z'). |
| `from_date` | string | Yes | Start date-time for the query. Accepts various formats including simple dates ('2024-01-01') or ISO 8601 ('2024-01-01T00:00:00Z'). |
| `dateFormat` | string | No | Moment.js format string for dates in the response. Common formats: 'YYYY-MM-DD' (2024-01-31), 'MMMM Do YYYY' (January 31st 2024). |
| `sourceType` | string ("site" | "social" | "organic" | "internal") | Yes | Type of source to retrieve. Must be one of: site (referring websites), social (social media platforms), organic (search engines), or internal (internal traffic sources). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transaction Metrics

**Slug:** `GOSQUARED_GET_TRENDS_TRANSACTION`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People

**Slug:** `GOSQUARED_LIST_PEOPLE`

Search and filter tracked people in GoSquared People CRM. Use this tool to: - List all tracked people or search by text query - Filter people by properties (email, name, etc.) or tracked events - Sort results by any property (default: most recently seen first) - Paginate through large result sets - Export results as JSON or CSV format - Get total count of matching people via 'cardinality' field Returns a structured response with 'list' (array of people), 'cardinality' (total count), and optional pagination links. Each person includes their ID, tracked properties, events, and links to related resources.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current concurrent visitors

**Slug:** `GOSQUARED_NOW_CONCURRENTS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Popular Pages

**Slug:** `GOSQUARED_NOW_PAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `href` | string | No | Full URL of a specific page to filter by (e.g., 'https://example.com/page'). URL encoding is handled automatically. If not provided, returns all pages with active visitors. |
| `limit` | string | No | Controls pagination. Format: 'offset,count' where offset is the starting position (0-based) and count is the number of results to return. If omitted, defaults to '0,10' (first 10 results). You can also specify just a count (e.g., '10'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Visitor Platforms

**Slug:** `GOSQUARED_NOW_PLATFORMS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum number of results to return; may include offset as 'offset,count' (e.g., '5,10'). |
| `presenter` | string ("truncatedList" | "list" | "truncatedObject" | "object") | No | Alters response shape; one of: 'truncatedList', 'list', 'truncatedObject', 'object'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Overview

**Slug:** `GOSQUARED_NOW_V3_OVERVIEW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date-time for the query in ISO 8601 or any Moment.js-compatible format. |
| `from_date` | string | No | Start date-time for the query in ISO 8601 or any Moment.js-compatible format. |
| `dateFormat` | string | No | Format for returned date fields; accepts any Moment.js format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Now Sources

**Slug:** `GOSQUARED_NOW_V3_SOURCES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum results per source category. Format: "offset,count" (e.g., "0,10" returns first 10 results). Default: "0,10". |
| `minimal` | boolean | No | If true, returns a compact response with only visitor counts. Default: false. |
| `sections` | string | No | Comma-separated list of source categories to retrieve. Available values: direct, site, social, organic, internal. Default: "direct,site,social,organic,internal". |
| `drillLimit` | string | No | Maximum drill-down results within each source item. Format: "offset,count" (e.g., "0,5"). Default: "0,5". |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Visitor Time Series

**Slug:** `GOSQUARED_NOW_V3_TIME_SERIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_time` | string | No | 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. |
| `interval` | string | No | 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'. |
| `from_time` | string | No | 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'. |
| `dateFormat` | string | No | Moment.js format string for date values in the response. For example, 'YYYY-MM-DD' returns dates as '2024-01-01'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-Time Online Visitors

**Slug:** `GOSQUARED_NOW_VISITORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Maximum results to return; supports 'offset,count' (e.g., '5,10'). |
| `to_date` | string | No | End date-time for the query window (ISO-8601). |
| `from_date` | string | No | Start date-time for the query window (ISO-8601). |
| `dateFormat` | string | No | Moment.js format string for returned date fields. |
| `visitorsMode` | string ("all" | "tagged" | "returning") | No | Subset of visitors to return; one of 'all', 'tagged', or 'returning'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### GoSquared - List All Devices

**Slug:** `GOSQUARED_PEOPLE_DEVICES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Smart Group Feed

**Slug:** `GOSQUARED_PEOPLE_SMARTGROUP_FEED`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date-time (ISO 8601 format) to filter the export. When combined with from_date, the range must not exceed 60 days. |
| `group_id` | string | Yes | 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. |
| `from_date` | string | No | Start date-time (ISO 8601 format) to filter the export. When combined with to_date, the range must not exceed 60 days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Smart Group People

**Slug:** `GOSQUARED_PEOPLE_SMARTGROUP_PEOPLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for results in format 'property:direction'. Direction is 'asc' (ascending) or 'desc' (descending). Common sort properties: last.seen, first.seen, name, email. |
| `limit` | string | No | 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. |
| `query` | string | No | Optional search term to filter people within the Smart Group by name, email, or other indexed properties. |
| `fields` | string | No | 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. |
| `group_id` | string | Yes | 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. |
| `presenter` | string ("plain" | "csv") | No | Response format. 'plain' returns JSON array of person objects. 'csv' returns data as CSV text for export. |
| `dateFormat` | string | No | Optional Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD', 'MM/DD/YYYY HH:mm'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People Smart Groups

**Slug:** `GOSQUARED_PEOPLE_SMART_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Account Site

**Slug:** `GOSQUARED_POST_ACCOUNT_SITES`

Creates a new site/project in the GoSquared account for analytics tracking. Returns the site_token needed to configure tracking on the new site. Requires: API key with 'write_account' scope (not supported by demo key).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Publicly accessible site URL to track (must start with http:// or https://). |
| `name` | string | No | Display name for the new site (optional). |
| `timezone` | string | No | IANA timezone for the site (server default: Europe/London). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Chat Conversation

**Slug:** `GOSQUARED_POST_CHAT_CHAT_ARCHIVE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatID` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Chat Message

**Slug:** `GOSQUARED_POST_CHAT_CHAT_MESSAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auth` | string | No | 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. |
| `chatID` | string | Yes | 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. |
| `sender` | string ("agent" | "client" | "bot") | No | Who is sending the message. Use 'agent' for support staff messages (default), 'bot' for automated responses, or 'client' for visitor messages (requires auth). |
| `content` | string | Yes | The text content of the message to send. |
| `timestamp` | integer | No | Unix epoch timestamp (seconds) for the message. Defaults to current time if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Leave Chat Note

**Slug:** `GOSQUARED_POST_CHAT_CHAT_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatID` | string | Yes | The ID of the chat conversation (same as the person_id of the client). |
| `sender` | string ("agent" | "client" | "bot") | No | Sender type of the note. Accepted values: 'agent', 'client', or 'bot'. |
| `content` | string | Yes | The text content of the note. |
| `timestamp` | integer | No | Unix timestamp of the note. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive Chat Conversation

**Slug:** `GOSQUARED_POST_CHAT_CHAT_UNARCHIVE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatID` | string | Yes | The unique identifier of the chat conversation to unarchive. This ID can be obtained from the 'id' field returned by the 'Retrieve Chat Conversations' (GOSQUARED_CHAT_CHATS) action or from the chat feed. The chat ID is the same as the person_id of the client. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create People SmartGroup

**Slug:** `GOSQUARED_POST_PEOPLE_SMARTGROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the Smart Group |
| `prefs` | object | No | Optional preferences for the Smart Group |
| `filters` | array | Yes | List of filter objects defining group membership |
| `sortDir` | string ("asc" | "desc") | No | Sort direction, either 'asc' or 'desc' |
| `sortField` | string | No | Field to sort members by |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Tracking Ping

**Slug:** `GOSQUARED_SEND_TRACKING_PING`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | object | Yes | Page information for the ping, including the page index and optionally the engaged time in milliseconds. |
| `visitor_id` | string | Yes | The anonymous visitor ID associated with this action. Use a consistent ID across the session to track the same visitor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Tag Visitor

**Slug:** `GOSQUARED_TAG_VISITOR`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | The tag to attach to the visitor. Used for segmenting and organizing visitors. |
| `visitorID` | string | Yes | The unique identifier of the visitor to tag. This is the visitor ID tracked by GoSquared. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track GoSquared Event

**Slug:** `GOSQUARED_TRACKING_EVENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Identify User

**Slug:** `GOSQUARED_TRACKING_IDENTIFY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_id` | string | Yes | Unique identifier for the person. Use 'email:' prefix for email-based identification (e.g., 'email:user@example.com') or provide a custom ID string. |
| `properties` | object | No | 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. |
| `visitor_id` | string | No | Anonymous visitor ID to merge with this person's profile. Used to link previous anonymous browsing activity to the identified user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track Pageview

**Slug:** `GOSQUARED_TRACKING_PAGEVIEW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | Visitor IP address (used for geolocation) |
| `page` | object | Yes | Information about the page being viewed |
| `total` | object | No | Aggregate visit and pageview counts for the visitor. |
| `screen` | object | No | Screen properties of the visitor. |
| `campaign` | object | No | Campaign data for pageview. |
| `language` | string | No | Browser language |
| `location` | object | No | Visitor location information. |
| `referrer` | string | No | Referrer URL |
| `returning` | boolean | No | Whether the visitor has returned before |
| `timestamp` | string | No | ISO 8601 timestamp of this pageview |
| `user_agent` | string | No | Browser user-agent string |
| `visitor_id` | string | Yes | Unique identifier for the anonymous visitor. Use a consistent ID across sessions to track the same visitor over time. |
| `character_set` | string | No | Browser character set |
| `last_pageview` | string | No | ISO 8601 timestamp of last pageview |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track GoSquared Transaction

**Slug:** `GOSQUARED_TRACKING_TRANSACTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | Visitor's IP address for geolocation detection. |
| `page` | object | No | Page context where the transaction occurred. Keys: 'url' (string), 'title' (string), 'previous' (number, page index), 'index' (number), 'referrer' (string). |
| `total` | object | No | Session totals. Keys: 'visits' (number of visits), 'pageviews' (total pageviews). |
| `screen` | object | No | Visitor's screen information. Keys: 'height', 'width', 'pixel_ratio', 'depth'. |
| `campaign` | object | No | Marketing campaign attribution data. Keys: 'name', 'source', 'medium', 'content', 'term'. |
| `language` | string | No | Language setting of the visitor's browser (e.g., 'en-US'). |
| `location` | object | No | Location context. Keys: 'timezone_offset' (minutes from UTC). |
| `person_id` | string | No | People CRM person ID to associate with this transaction. Prefix with 'email:' when using an email address (e.g., 'email:customer@example.com'). |
| `returning` | boolean | No | Whether this visitor is a returning customer. |
| `timestamp` | string | No | ISO 8601 timestamp of when the transaction occurred. Defaults to current time if not specified. |
| `user_agent` | string | No | User agent string of the visitor's browser. |
| `visitor_id` | string | No | Anonymous visitor ID to associate with this transaction. Use this to link the transaction to a browser session. |
| `transaction` | object | Yes | 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). |
| `character_set` | string | No | Character set of the visitor's browser (e.g., 'UTF-8'). |
| `last_pageview` | string | No | ISO 8601 timestamp of the visitor's last pageview. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track User Properties

**Slug:** `GOSQUARED_TRACK_PROPERTIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Full name of the person |
| `email` | string | No | Email address of the person |
| `phone` | string | No | Phone number of the person |
| `avatar` | string | No | URL of an avatar image for this person |
| `custom` | object | No | Custom properties with automatic type detection (Text, Number, Date, Boolean, or Null). Maximum 1000 custom properties per project; excess properties are ignored. |
| `status` | string | No | Current status of the person |
| `company` | object | No | Company information for a person. |
| `username` | string | No | Username of the person |
| `last_name` | string | No | Last name of the person |
| `person_id` | string | No | 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. |
| `created_at` | string | No | ISO 8601 timestamp when the person was created |
| `first_name` | string | No | First name of the person |
| `visitor_id` | string | No | Anonymous visitor identifier. Use to track properties for visitors who haven't been identified yet. Either person_id or visitor_id must be provided. |
| `description` | string | No | Biography or description of the person |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Aggregate Metrics

**Slug:** `GOSQUARED_TRENDS_AGGREGATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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. |
| `format` | string ("json" | "csv") | No | Response format. Use 'json' for structured data (default) or 'csv' for comma-separated values export. |
| `to_date` | string | Yes | End date-time for the analytics query in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). This is required. |
| `interval` | string ("hour" | "day" | "month") | No | Time interval for grouping/aggregating data points. Use 'hour' for hourly breakdown, 'day' for daily (default), or 'month' for monthly aggregation. |
| `from_date` | string | Yes | Start date-time for the analytics query in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). This is required. |
| `dateFormat` | string | No | Optional Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD' for dates like '2024-01-01'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Medium Metrics

**Slug:** `GOSQUARED_TRENDS_CAMPAIGN_MEDIUM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Limit results with optional offset,count notation (e.g., '0,20' for first 20 results, '5,10' for 10 results starting at offset 5). |
| `to_date` | string | Yes | End date for the query in ISO 8601 format (e.g., '2024-01-07' or '2024-01-07T23:59:59Z'). |
| `from_date` | string | Yes | Start date for the query in ISO 8601 format (e.g., '2024-01-01' or '2024-01-01T00:00:00Z'). |
| `date_format` | string | No | Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD'). |
| `response_format` | string ("json" | "csv") | No | Response format: 'json' (default) or 'csv'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Event Counts

**Slug:** `GOSQUARED_TRENDS_EVENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | 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. |
| `format` | string ("json" | "csv") | No | Response format. Use 'json' for structured data or 'csv' for comma-separated values export. |
| `to_date` | string | Yes | End date-time for the query. Accepts ISO 8601 format (e.g., '2024-01-07T23:59:59Z') or date strings like '2024-01-07'. |
| `from_date` | string | Yes | Start date-time for the query. Accepts ISO 8601 format (e.g., '2024-01-01T00:00:00Z') or date strings like '2024-01-01'. |
| `dateFormat` | string | No | Optional Moment.js format string for formatting date fields in the response (e.g., 'YYYY-MM-DD', 'DD/MM/YYYY'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Page Metrics

**Slug:** `GOSQUARED_TRENDS_PAGE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Base Path Metrics

**Slug:** `GOSQUARED_TRENDS_PATH1`

Retrieves base path metrics (first URL path segments) over a time period. Use this to analyze which top-level URL paths (e.g., '/blog', '/products', '/wiki') receive the most traffic. Useful for understanding site structure usage and identifying popular content sections. Requires 'read_trends' scope in your API key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | string | No | Pagination control as 'offset,count'. Default is '0,20' (first 20 results). Use '10,50' to skip 10 and return 50 results. |
| `format` | string ("json" | "csv") | No | Response format. Use 'json' for structured data (default) or 'csv' for comma-separated values export. |
| `to_date` | string | Yes | 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'). |
| `from_date` | string | Yes | 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'). |
| `dateFormat` | string | No | Optional Moment.js format string for date fields in the response (e.g., 'YYYY-MM-DD', 'MMM D, YYYY'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Blocked Bots

**Slug:** `GOSQUARED_UPDATE_ACCOUNT_BLOCKED_BOTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `block` | boolean | Yes | Whether to block bots or not. Set to true to enable automatic bot blocking, false to disable it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Blocked IPs

**Slug:** `GOSQUARED_UPDATE_ACCOUNT_BLOCKED_IPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |