Retrieve Chat Feed
Tool to retrieve messages and events from a chat conversation. Use when you need to fetch chat history for a specific chat session.
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.
Get specific chat message
Tool to retrieve a specific chat message. Use when you have both chat ID and message ID to fetch the message details.
Get Specific Visitor
Tool to retrieve information for a specific online visitor. Use after obtaining visitorID to get detailed visit data.
Get People Event Types
Tool to retrieve event types ordered by tracked count. Use when you need to display the most tracked event types.
Get People Property Types
Tool to retrieve all property types in People CRM. Use when you need to discover available profile or event properties.
Get Person
Tool to retrieve a specific person profile by ID. Use when you need to fetch details of a person by their unique identifier.
GoSquared - Get Person Feed
Tool to retrieve a specific person's event feed in reverse chronological order. Use after confirming the personID.
List People
Tool to search and filter People CRM profiles. Use when you need to retrieve a list of people based on query terms, specific property or event filters, sorting, and pagination.
Get current concurrent visitors
Tool to retrieve the number of concurrent visitors currently on your site. Use when you need live, real-time visitor metrics.
Get Real-Time Popular Pages
Tool to retrieve the most popular pages currently being viewed on your site. Use when real-time active page data is needed.
Get Real-Time Visitor 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.
Get Real-Time 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.
Now 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.
Get Time Series
Tool to retrieve visitor counts over time as data points. Use when you need historical visitor data bucketed by interval.
Get Real-Time Online Visitors
Tool to retrieve a list of current online visitors. Use when you need detailed real-time visitor information.
GoSquared - People Devices
Tool to retrieve device information from People CRM. Use when you need a paginated view of a user's device usage.
Export Smart Group Feed
Tool to export all pageview activity for a Smart Group to CSV. Use when you need a temporary download link for up to 60 days of data; link expires after 15 minutes.
Smart Group People
Tool to retrieve people in a specific Smart Group. Use when listing or filtering members of a Smart Group.
List People SmartGroups
Tool to retrieve all Smart Groups for a project. Use when you need to list the Smart Groups configured in your People project.
Add Account Site
Tool to add a new site to the GoSquared account. Use when you want to register a new site for data collection under your account.
Archive Chat Conversation
Tool to archive a chat conversation. Use when you need to programmatically close out a chat after its session ends.
Send Chat Message
Tool to send a message in a chat conversation. Use after confirming chatID and providing auth if sending as client.
Leave Chat Note
Tool to leave a note in a chat conversation. Use when you need to annotate or add comments to an existing chat session.
Unarchive Chat Conversation
Tool to unarchive a chat conversation. Use when you need to restore an archived chat back to active state after confirming that the conversation should be resumed.
Create People SmartGroup
Tool to add a new Smart Group to a GoSquared project. Use when you need to segment users by custom criteria.
Track GoSquared Event
Tool to send custom events to GoSquared. Use when tracking user or system events in analytics.
Track GoSquared Identify
Tool to identify users and associate them with specific properties in GoSquared. Use after obtaining or confirming a visitor’s identity to link their anonymous activity with thei…
Track Pageview
Tool to track pageviews. Use when you need to record a pageview event for a visitor after obtaining their visitor_id and page details.
Track GoSquared Transaction
Tool to track e-commerce transactions. Use when a user completes a purchase and you need to record the transaction in GoSquared.
Retrieve Aggregate Metrics
Tool to retrieve aggregate metrics for a specified period. Use after specifying both start and end date-times to obtain summarised metrics, optionally grouped by interval.
Get Campaign Medium Metrics
Tool to retrieve UTM medium metrics over a time period. Use when analyzing campaign performance by medium.
Retrieve Event Counts
Tool to retrieve counts of event triggers over a specified time period. Use when you need to analyze event frequency for a site between two date-times.
Get Page Metrics
Tool to retrieve page-level metrics over a specified period. Use when you want summarised page metrics for individual pages within a date range.
Get Base Path Metrics
Tool to retrieve base path metrics over a time period. Use when you need to analyze the most common entry page paths for a site within a specified date range.