archive_chat
Archive Chat
Archive or unarchive a chat conversation in GoSquared Assistant.
archive_chat
Archive or unarchive a chat conversation in GoSquared Assistant.
track_transaction
Track an ecommerce transaction in GoSquared. Transactions record purchases with item details, revenue, and quantity. Data appears in Ecommerce Analytics and People CRM. Duplicate transaction IDs are automatically prevented.
send_chat_message
Send a message in a GoSquared Assistant chat conversation. Messages are sent as the agent (owner of the API key). Can be used for automated messaging in response to events.
track_event
Track a custom event in GoSquared. Events can represent user actions, application errors, state transitions, or any activity. Events appear in Trends and on individual user profiles in People CRM.
get_realtime_analytics
Retrieve real-time concurrent analytics data from GoSquared. Get current visitor counts, popular pages, traffic sources, visitor locations, engagement metrics, and individual visitor details. Select one or more dimensions to include.
identify_user
Create or update a user profile in GoSquared People CRM. Associates a person with profile properties like name, email, phone, company info, and custom properties. Use this to import user profiles or update existing ones.
track_pageview
Track a pageview in GoSquared server-side. Useful for recording page visits from non-browser environments or server-rendered pages.
list_smart_groups
Retrieve all Smart Groups configured in GoSquared People CRM. Returns group names and their applied filters.
get_chat_messages
Retrieve messages from a specific chat conversation in GoSquared Assistant. Returns the full message history for a given chat.
list_chats
Retrieve live chat conversations from GoSquared Assistant. Returns active chat conversations with optional date range filtering and pagination.
get_historical_analytics
Retrieve historical analytics data from GoSquared Trends API. Get aggregate metrics or break them down by dimension (browser, country, event, page, source, campaign, language, OS, etc.) over any time period.
get_person
Retrieve detailed profile information for a specific person in GoSquared People CRM. Returns all stored properties, activity data, and optionally their event feed and devices.
search_people
Search and filter users in GoSquared People CRM. Supports free-text search, property/event-based filters, field selection, sorting, and pagination. Returns matching user profiles.
create_smart_group
Create a new Smart Group in GoSquared People CRM. A Smart Group is a saved filter/segment of users based on properties or events.
get_smart_group_members
Retrieve the people belonging to a specific Smart Group in GoSquared People CRM. Supports search, field selection, sorting, and pagination.
add_chat_note
Leave an internal note on a GoSquared Assistant chat conversation. Notes are visible only to agents, not to the visitor.
delete_person
Permanently delete a person's profile and all associated data from GoSquared People CRM. Optionally blacklist the person to prevent re-creation and block webhooks/integrations for them.
Track and retrieve real-time and historical web analytics data including visitors, pages, traffic sources, and campaigns. Identify and manage users in a People CRM with profile data, custom properties, smart groups, and activity timelines. Track events, pageviews, and ecommerce transactions. Send and receive live chat messages, manage conversations, and leave agent notes. Search and filter users, create smart groups, and retrieve segmented user data. Manage account settings, sites, shared users, webhooks, and notification triggers. Receive webhook notifications for smart group membership changes, traffic spikes, and new chat messages.
Common questions about connecting Gosquared to AI agents with Metorial.