# GoSquared integration

> Web analytics, live chat and People CRM: realtime and historical traffic, visitor profiles, events, transactions, chats, smart groups and webhooks.

- Authentication: apiKey

## Tools (97)

- **Add Chat Note**: Leaves a note in a conversation.
- **Add Site**: Creates a project and returns its details including `site_token`. Tracking still needs the tracking code or a client library. Needs only `api_key`.
- **Add Smart Group**: Creates a Smart Group. Filters use the same `key`/`path`/`operator`/`value` objects as Search People.
- **Add Team Member**: Shares the project with a user by email; an email with no GoSquared account is invited to create one.
- **Add Webhook**: Creates a webhook.
- **Add Webhook Trigger**: Adds a trigger to a webhook.
- **Archive Chat**: Archives a chat conversation.
- **Block Visitor**: Adds a visitor to the project blocked list.
- **Delete Person**: Irreversibly deletes a profile and its data; tracking the person again creates a blank profile unless blacklisted. Needs an API key with Write People permission.
- **Delete Webhook**: Deletes a webhook.
- **Export Smart Group Feed**: Exports pageview activity of the group to a CSV; the response links to the download, valid 15 minutes. Max 60 days per request.
- **Get Blocked Bots Setting**: Whether automatic bot blocking is on for the project.
- **Get Chat**: One chat conversation.
- **Get Chat Feed**: Retrieves a list of messages and events from a conversation.
- **Get Chat Message**: Retrieves a specific chat message by ID.
- **Get Concurrent Visitors**: Summary of all concurrently online visitors.
- **Get Device**: Details of one device (platform, browser, user agent, screen size, ISP, location, total visits).
- **Get Historical Aggregate Data**: Summarised aggregate metrics (powers the trends timeline and totals) over a time period.
- **Get Historical Base Path Data**: Summarised base path metrics over a time period.
- **Get Historical Browser Data**: Summarised browser metrics over a time period.
- **Get Historical Country Data**: Summarised country metrics over a time period.
- **Get Historical Event Data**: Number of times events were triggered over a time period; the event `data` property is excluded (see People feed).
- **Get Historical Language Data**: Summarised language metrics over a time period.
- **Get Historical Operating System Data**: Summarised operating system metrics over a time period.
- **Get Historical Organisation Data**: Summarised organisation metrics over a time period.
- **Get Historical Page Data**: Summarised page metrics over a time period.
- **Get Historical Screen Dimensions Data**: Summarised screen dimensions metrics over a time period.
- **Get Historical Sources By Type**: Historical sources for one source type.
- **Get Historical Sources Data**: Historical sources that referred visitors, grouped by direct, organic, site and social.
- **Get Historical UTM Campaign Data**: Summarised UTM campaign metrics over a time period.
- **Get Historical UTM Content Data**: Summarised UTM content metrics over a time period.
- **Get Historical UTM Medium Data**: Summarised UTM medium metrics over a time period.
- **Get Historical UTM Source Data**: Summarised UTM source metrics over a time period.
- **Get Historical UTM Term Data**: Summarised UTM term metrics over a time period.
- **Get Online Visitor**: Information for one visitor.
- **Get Online Visitor Locations**: Coordinates for currently online visitors.
- **Get Person**: One profile with all its properties.
- **Get Person Feed**: Events for a person, newest first: tracked `event`s and `sessionEvent`s (pageviews, session starts/ends).
- **Get Property Type**: One property by name.
- **Get Realtime Campaigns**: Currently running campaigns and how many online visitors each referred.
- **Get Realtime Engagement**: Engagement of online visitors: `timeOnSite` and `visitDepth`, each with a `breakdown` object (key = seconds or page count, value = visitors) and an `average`.
- **Get Realtime Overview**: Summary for the site: people online, active pages, and historical visitor min, max and averages.
- **Get Realtime Sources By Type**: Online-visitor sources for one source type.
- **Get Realtime Time Series**: Data points of visitor count over time, as plotted on the Now dashboard.
- **Get Server Time**: Current time according to GoSquared infrastructure.
- **Get Site**: Details for one project by its site token. Needs only `api_key`.
- **Get Sites Usage**: Retrieves all sites and their pageview count.
- **Get Smart Group**: Retrieves a single Smart Group by its groupID.
- **Get Token Info**: Returns `scopes`, an array such as `read_account`, showing the key access level. Needs only `api_key`; useful to validate a key.
- **Get Trigger Type**: One type of trigger.
- **Get Webhook**: Retrieves a webhook.
- **Get Webhook Trigger**: Retrieves one trigger for a webhook.
- **List Active Chats**: Active chat conversations.
- **List Archived Chats**: Archived chat conversations.
- **List Blocked IPs**: Retrieves a list of blocked IP addresses.
- **List Blocked Items**: Blocked IP addresses, bots and visitors.
- **List Blocked Visitors**: Retrieves a list of visitor IDs that have been blocked for the project.
- **List Chat Messages**: Messages in a conversation.
- **List Custom Property Types**: Only custom property types.
- **List Devices**: Paginated list of every device tracked in People CRM.
- **List Event Types**: Events tracked in People CRM, ordered by times tracked.
- **List Notifications**: Notifications shown on the Now and Trends dashboards: traffic alerts, RSS items from feeds, and manually added milestones.
- **List Online Browsers**: Lists the browsers of currently online visitors, sorted by visitor count.
- **List Online Countries**: Lists the countries of currently online visitors, sorted by visitor count.
- **List Online Languages**: Lists the languages of currently online visitors, sorted by visitor count.
- **List Online Organisations**: Lists the internet organisations of currently online visitors, sorted by visitor count.
- **List Online Platforms**: Lists the platforms of currently online visitors, sorted by visitor count.
- **List Online Visitors**: Online visitors with their details and the pages they are viewing.
- **List Pages With Online Visitors**: Pages with active visitors, ordered by visitor count. With `href`, returns that page only.
- **List Person Devices**: Paginated list of devices a specific person has used.
- **List Property Types**: All property types in People CRM; names use dot notation (e.g. `last.location.coordinates`).
- **List Realtime Sources**: Sources that referred online visitors, grouped by direct, organic, site and social (the last three can be grouped by engine/domain).
- **List Sites**: All projects/sites the account owns or has shared access to. Needs only `api_key`.
- **List Smart Group People**: People in a Smart Group; equivalent to Search People with the group filters.
- **List Smart Groups**: Saved Smart Groups with the filters applied to each.
- **List Tagged Visitors**: Tagged visitors.
- **List Team Members**: Team members with access to the project, each with a state: `owner`, `active` (shared user) or `pending` (invited, not signed up).
- **List Trigger Types**: Types of webhook triggers.
- **List Webhooks**: Webhooks for the project.
- **List Webhook Triggers**: Retrieves all triggers for a webhook.
- **Ping Tracking Session**: Keeps a visitor session alive; a ping is needed at least every 30 seconds or the session times out. Mainly for custom libraries.
- **Remove Team Member**: Removes a user from the project. The docs show the verb as `DEL`; send HTTP DELETE.
- **Remove Visitor Tag**: Removes the visitor's tag. The docs show the verb as `DEL`; send HTTP DELETE.
- **Remove Webhook Trigger**: Removes a trigger from a webhook.
- **Search People**: Searches and filters People CRM profiles. `filters` is a JSON array of objects with `key` (`property` or `event`), `path`, `operator` (e.g. `contains`) and `value`.
- **Send Chat Message**: Sends a message as agent (the API key owner) or client. A client message needs the `auth` query param: an HMAC-SHA256 of the person id keyed with the project Secure Mode secret.
- **Tag Visitor**: Adds a tag to an identified visitor.
- **Timeout Tracking Session**: Ends all sessions for a visitor, or only the one for `page.index` if given.
- **Track Event**: Records a custom event. Each project tracks up to 1000 distinct event names; new names past that are ignored. Event `data` is viewable per profile in People CRM, not searchable.
- **Track Pageview**: Records a pageview. A visitor times out if no ping arrives within 30 seconds. Only the JavaScript tracker or direct HTTP can track pageviews.
- **Track Properties**: Sets People profile properties. Custom properties are auto-typed (Text, Number, Date, Boolean, Null); each project tracks up to 1000 custom properties, new names past that are ignored.
- **Track Transaction**: Records an ecommerce purchase. A repeated `transaction.id` is rejected as a duplicate. Test transactions cannot be removed from the Ecommerce dashboard, so use a test project.
- **Unarchive Chat**: Un-archives a chat conversation.
- **Unblock IPs**: Removes one or more IP addresses from the blocked list.
- **Unblock Visitor**: Removes a visitor from the blocked list. The docs show the verb as `DEL`; send HTTP DELETE.
- **Update Blocked Bots Setting**: Turns automatic bot blocking on or off for the project.
- **Update Blocked IPs**: Updates the list of blocked IP addresses for the project.

Connect GoSquared in General Input: https://www.generalinput.com/apps/gosquared