Gosquared

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

Tool to remove a user from a GoSquared project. Use when you need to revoke a shared user's access to your site.

Tool to retrieve all team members that have access to a given project. Use after specifying the project to inspect user access.

Tool to list all projects/sites accessible to the authenticated account. Use when you need to retrieve the account's sites in either grouped or flat format.

Tool to check whether an API key is valid and retrieve its enabled scopes. Use when verifying API credentials before making further API calls.

Tool to retrieve a chat conversation by its ID. Use when you need the full conversation history after obtaining a chat session ID.

Tool to retrieve a list of messages from a chat conversation. Use after identifying the chatID via listing chat conversations to page through a chat's message history.

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

Tool to retrieve messages and events from a chat conversation. Use when you need to fetch chat history for a specific chat session.

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.

Tool to retrieve a specific chat message. Use when you have both chat ID and message ID to fetch the message details.

Tool to retrieve information for a specific online visitor. Use after obtaining visitorID to get detailed visit data.

Tool to retrieve event types ordered by tracked count. Use when you need to display the most tracked event types.

Tool to retrieve all property types in People CRM. Use when you need to discover available profile or event properties.

Tool to retrieve a specific person profile by ID. Use when you need to fetch details of a person by their unique identifier.

Tool to retrieve a specific person's event feed in reverse chronological order. Use after confirming the personID.

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.

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

Tool to retrieve the most popular pages currently being viewed on your site. Use when real-time active page data is needed.

Tool to retrieve platforms used by online visitors sorted by visitor count. Use when you need a real-time breakdown of active visitor platforms.

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.

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.

Tool to retrieve visitor counts over time as data points. Use when you need historical visitor data bucketed by interval.

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

Tool to retrieve device information from People CRM. Use when you need a paginated view of a user's device usage.

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.

Tool to retrieve people in a specific Smart Group. Use when listing or filtering members of a Smart Group.

Tool to retrieve all Smart Groups for a project. Use when you need to list the Smart Groups configured in your People project.

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.

Tool to archive a chat conversation. Use when you need to programmatically close out a chat after its session ends.

Tool to send a message in a chat conversation. Use after confirming chatID and providing auth if sending as client.

Tool to leave a note in a chat conversation. Use when you need to annotate or add comments to an existing chat session.

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.

Tool to add a new Smart Group to a GoSquared project. Use when you need to segment users by custom criteria.

Tool to send custom events to GoSquared. Use when tracking user or system events in analytics.

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 their known user record and update their profile.

Tool to track pageviews. Use when you need to record a pageview event for a visitor after obtaining their visitor_id and page details.

Tool to track e-commerce transactions. Use when a user completes a purchase and you need to record the transaction in GoSquared.

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.

Tool to retrieve UTM medium metrics over a time period. Use when analyzing campaign performance by medium.

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.

Tool to retrieve page-level metrics over a specified period. Use when you want summarised page metrics for individual pages within a date range.

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.