GoSquared
Gosquared API integration for analytics and automation
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.gosquared.com/ | link | — | — | — |
Actions (74)
Account · 24
- Add shared userPOST /account/v1/sharedUsers
Invite/add a user by email to the project.
documented - Add sitePOST /account/v1/sites
Create a new site to be tracked by GoSquared.
documented - Add webhook triggerPOST /account/v1/webhooks/{webhookID}/triggers
Add a trigger to a webhook.
documented - Create webhookPOST /account/v1/webhooks
Create a new webhook.
documented - Create webhook triggerPOST /account/v1/webhooks/{webhookID}/triggers
Create a new trigger for a webhook.
documented - Delete blocked IPs
Remove blocked IPs.
documented - Get webhookGET /account/v1/webhooks/{webhookID}
Retrieve a webhook by ID.
documented - Get webhook triggerGET /account/v1/webhooks/{webhookID}/triggers/{triggerID}
Retrieve a webhook trigger.
documented - List blockedGET /account/v1/blocked
List blocked IPs, bots and visitors.
documented - List blocked IPsGET /account/v1/blocked/ips
List blocked IP addresses.
documented - List blocked botsGET /account/v1/blocked/bots
Get blocked bots setting.
documented - List blocked visitorsGET /account/v1/blocked/visitors
List blocked visitor IDs.
documented - List shared usersGET /account/v1/sharedUsers
List team members with access to a project.
documented - List sitesGET /account/v1/sites
Obtain a full list of sites for an account.
documented - List webhook triggersGET /account/v1/webhooks/{webhookID}/triggers
List triggers configured for a webhook.
documented - List webhooksGET /account/v1/webhooks
List account webhooks.
documented - Remove shared user
Remove a shared user by email.
documented - Remove webhook trigger
Remove a webhook trigger.
documented - Unblock visitor
Remove a visitor from the blocked list.
documented - Update blocked IPsPOST /account/v1/blocked/ips
Update the list of blocked IP addresses.
documented - Update blocked botsPOST /account/v1/blocked/bots
Toggle automated bot blocking for a project.
documented - Update blocked visitorPOST /account/v1/blocked/visitors/{visitorID}
Block or unblock a specific visitor.
documented - Update webhook triggerPOST /account/v1/webhooks/{webhookID}/triggers
Update an existing trigger for a webhook.
documented - Update webhook triggerPOST /account/v1/webhooks/{webhookID}/triggers
Update an existing trigger for a webhook.
documented
Now API · 17
- Retrieve a Time SeriesGET /now/v3/timeSeries
Return a time series of visitors over time.
documented - Retrieve a visitorGET /now/v3/visitors/{visitorID}
Return details for a specific visitor.
documented - Retrieve concurrent visitorsGET /now/v3/concurrents
Return a summary of visitors currently online.
documented - Retrieve countriesGET /now/v3/countries
Return current-country distribution of online visitors.
documented - Retrieve geographic user informationGET /now/v3/geo
Return geographic coordinates for online visitors.
documented - Retrieve languagesGET /now/v3/languages
Return languages used by online visitors.
documented - Retrieve list of browsersGET /now/v3/browsers
Return the browsers currently in use by online visitors.
documented - Retrieve notificationsGET /now/v3/notifications
Return alerts/markers shown on Now dashboards.
documented - Retrieve online visitorsGET /now/v3/visitors
Return a list of online visitors.
documented - Retrieve organisationsGET /now/v3/organisations
Return organisations of online visitors.
documented - Retrieve pagesGET /now/v3/pages
Return pages with active visitors.
documented - Retrieve platformsGET /now/v3/platforms
Return platforms used by online visitors.
documented - Retrieve realtime campaignsGET /now/v3/campaigns
Return currently active campaigns and their realtime counts.
documented - Retrieve realtime engagementGET /now/v3/engagement
Return engagement metrics for currently online users.
documented - Retrieve realtime overviewGET /now/v3/overview
Return a site-level realtime snapshot (people online, active pages, etc).
documented - Retrieve sourcesGET /now/v3/sources
Return referrers to the site by source type.
documented - Retrieve the current timeGET /now/v3/time
Return the current time from GoSquared infrastructure.
documented
Trends API · 17
- Retrieve historical UTM campaign dataGET /trends/v2/campaign_name
Return UTM campaign metrics over a time range.
documented - Retrieve historical UTM content dataGET /trends/v2/campaign_content
Return UTM content metrics over a time range.
documented - Retrieve historical UTM medium dataGET /trends/v2/campaign_medium
Return UTM medium metrics over a time range.
documented - Retrieve historical UTM source dataGET /trends/v2/campaign_source
Return UTM source metrics over a time range.
documented - Retrieve historical UTM term dataGET /trends/v2/campaign_term
Return UTM term metrics over a time range.
documented - Retrieve historical aggregate dataGET /trends/v2/aggregate
Return summed metrics over a time range (aggregated by interval).
documented - Retrieve historical base path dataGET /trends/v2/path1
Return base path metrics over a time range.
documented - Retrieve historical browser dataGET /trends/v2/browser
Return browser metrics over a time range.
documented - Retrieve historical country dataGET /trends/v2/country
Return country metrics over a time range.
documented - Retrieve historical event dataGET /trends/v2/event
Return event counts over a time range.
documented - Retrieve historical language dataGET /trends/v2/language
Return language metrics over a time range.
documented - Retrieve historical operating system dataGET /trends/v2/os
Return OS metrics over a time range.
documented - Retrieve historical organisation dataGET /trends/v2/organisation
Return organisation metrics over a time range.
documented - Retrieve historical page dataGET /trends/v2/page
Return page metrics over a time range.
documented - Retrieve historical screen dimensionsGET /trends/v2/screenDimensions
Return screen dimension metrics over a time range.
documented - Retrieve historical sources by typeGET /trends/v2/sources/{sourceType}
Return sources metrics for a specific source type (site, social, organic, internal).
documented - Retrieve historical sources dataGET /trends/v2/sources
Return sources metrics over a time range.
documented
Tracking · 7
- Identify userPOST /tracking/v1/identify
Associate properties with a visitor/user for later analytics.
documented - PingPOST /tracking/v1/ping
Send a lightweight heartbeat to track connectivity.
documented - Record pageviewPOST /tracking/v1/pageview
Track a page view event for a visitor.
documented - Record transactionPOST /tracking/v1/transaction
Record an ecommerce transaction.
documented - Set timeoutPOST /tracking/v1/timeout
Configure or reset request timeouts for tracking calls.
documented - Track eventPOST /tracking/v1/event
Record a custom event for a user/session in GoSquared.
documented - Update propertiesPOST /tracking/v1/properties
Send additional properties for a user/visitor.
documented
Chat API · 4
- Leave a notePOST /chat/v1/notes/{conversationID}
Leave a note on a client conversation.
documented - List conversationsGET /chat/v1/conversations
Retrieve a list of chat conversations.
documented - List messagesGET /chat/v1/conversations/{conversationID}/messages
Retrieve messages for a conversation.
documented - Send a messagePOST /chat/v1/messages
Send a message as an agent or client in a chat.
documented
People API · 4
- Get personGET /people/{personID}
Retrieve a single person by ID.
documented - List peopleGET /people
Search and list People in the GoSquared account.
documented - List person's devicesGET /people/{personID}/devices
Return devices associated with a person.
documented - List person's eventsGET /people/{personID}/events
Retrieve events tied to a person.
documented