GoSquared

Unblock IP addresses -- Removes one or more IP addresses from the blocked list via DELETE /account/v1/blocked/ips

Unblock visitors -- Removes a visitor from the blocked list for a given project. via DELETE /account/v1/blocked/visitors/{visitorID}

Remove a team member -- Remove a user from a specific project so that they no longer have to access it. Note: Only API keys generated by the project owner have permission to be used with this endpoint. via DELETE /account/v1/sharedUsers

Remove a tagged visitor -- Removes the given visitorID's tag. via DELETE /account/v1/taggedVisitors/{visitorID}

Remove a webhook -- Deletes a webhook. via DELETE /account/v1/webhooks/{webhookID}

Remove a trigger from a webhook -- Remove a trigger from a webhook. via DELETE /account/v1/webhooks/{webhookID}/triggers/{triggerID}

Delete a person -- Delete a single profile from People CRM by its person_id . This will delete the profile and all its associated data. If this person is subsequently tracked again in the future, a new blank profile will be created for them, unless you use the blacklist parameter. This endpoint requires an API key with Write People permission. Note : This action is irreversible – deleted data cannot be recovered. via DELETE /people/v1/people/{personID}

Retrieve blocked items -- Retrieves a list of blocked IP addresses, bots and visitors. via GET /account/v1/blocked

Retrieve blocked bots setting -- Returns whether automatic bot blocking is toggled 'on' for a given project. via GET /account/v1/blocked/bots

Retrieve blocked IPs -- Retrieves a list of blocked IP addresses. via GET /account/v1/blocked/ips

Retrieve blocked visitors -- Retrieves a list of visitor IDs that have been blocked for a given project. Most commonly a visitor will have been blocked from hitting the 'Ignore' button from within the Visitor widget on your Now dashboard. via GET /account/v1/blocked/visitors

Retrieve team members (shared users) -- Retrieves a list of all the team members that have access to a given project. It also returns the state of each member. The state can be: 'owner' (they are the project owner), 'active' (they are a shared user) or 'pending' (they have been invited but haven't finished signing up to GoSquared). Note: Only API keys generated by the project owner have permission to be used with this endpoint. via GET /account/v1/sharedUsers

Retrieve sites -- Retrieves a list of all the projects/sites that this account either owns or has been granted shared access to. via GET /account/v1/sites

Retrieve a site -- Retrieves the details for site/project by its site_token via GET /account/v1/sites/{site_token}

Retrieve all sites and pageview count via GET /account/v1/sites/usage

Retrieve tagged visitors -- Retrieves the list of tagged visitors. via GET /account/v1/taggedVisitors

Retrieve the types of triggers -- Retrieve the types of triggers. via GET /account/v1/triggerTypes

Retrieve a type of trigger -- Retrieve a type of trigger. via GET /account/v1/triggerTypes/{triggerType}

Retrieve all webhooks -- Retrieves a list of webhooks. via GET /account/v1/webhooks

Retrieve a webhook -- Retrieves a webhook. via GET /account/v1/webhooks/{webhookID}

Retrieve all triggers for a webhook -- Retrieve all triggers for a webhook. via GET /account/v1/webhooks/{webhookID}/triggers

Retrieve an trigger for a webhook -- Retrieve an trigger for a webhook. via GET /account/v1/webhooks/{webhookID}/triggers/{triggerID}

Token Info -- Fetches the information for the given authorisation strategy. Returns a scopes property which is an array of scopes such as read_account indicating the access level that this token has. via GET /auth/v1/tokeninfo

Retrieve a list of archived chats -- Retrieve a list of archived chat conversations. via GET /chat/v1/archivedChats

Retrieve a list of active chats -- Retrieve a list of active chat conversations. via GET /chat/v1/chats

Retrieve a chat -- Retrieve a chat conversation by ID. via GET /chat/v1/chats/{chatID}

Retrieve a list of messages and events from a conversation -- Retrieve a list of messages and events from a conversation. via GET /chat/v1/chats/{chatID}/feed

Retrieve a list of messages -- Retrieve a list of messages from a conversation. via GET /chat/v1/chats/{chatID}/messages

Retrieve a message -- Retrieve a specific message by ID. via GET /chat/v1/chats/{chatID}/messages/{messageID}

Retrieve list of browsers -- Retrieves a list of the different browsers that currently online visitors are using, sorted by the number of visitors per browser. via GET /now/v3/browsers

Retrieve realtime campaigns -- Retrieves a list of currently running campaigns, displaying how many visitors online right now have been referred by campaigns. via GET /now/v3/campaigns

Retrieve concurrent visitors -- Retrieves a summary of all concurrently online visitors. via GET /now/v3/concurrents

Retrieve list of countries -- Retrieves a list of the different countries that currently online visitors are from, sorted by the number of visitors per country. via GET /now/v3/countries

Retrieve realtime engagement -- Retrieves engagement information of currently online users. Time on site The timeOnSite object contains breakdown and average time on site information. The breakdown is an object where each key is the time in seconds a visitor has remained on the site, and the value is the number of visitors in that group. The average key contains a float for the average number of seconds all visitors currently online have remained on the site. Visit Depth The visitDepth object contains breakdown and average visit depth information. Visit depth is the total number of pages visited by visitors on a website. Much like the timeOnSite object, it contains a breakdown object where each key is the total visit depth, and the value is the number of visitors in that group. The average key contains the average visit depth across all visitors currently online on the website. via GET /now/v3/engagement

Retrieve geographic user information -- Retrieves a list of co-ordinates for currently online users. via GET /now/v3/geo

Retrieve list of languages -- Retrieves a list of the different languages for currently online visitors, sorted by the number of visitors per language. via GET /now/v3/languages

Retrieve notifications -- Retrieves a list of notifications stored in GoSquared. Notifications are displayed on the Now and Trends dashboards as markers along the timeline and as part of the notifications widget. These Notifications can include: Traffic Alerts RSS items from feeds Manually added Milestones via GET /now/v3/notifications

Retrieve list of organisations -- Retrieves a list of the different internet organisations that currently online visitors are using, sorted by the number of visitors per organisation. via GET /now/v3/organisations

Retrieve a realtime overview -- Retrieves a summary of data for the site, including people online, the number of active pages and historical visitor min, max and averages. via GET /now/v3/overview

Retrieve pages with online visitors -- Retrieves a list of pages with active visitors, ordered by the number of visitors on the page. If a href parameter is given then information for that page will be returned. via GET /now/v3/pages

Retrieve list of platforms -- Retrieves a list of the different platforms that currently online visitors are using, sorted by the number of visitors per platform. via GET /now/v3/platforms

Retrieve sources -- Retrieves a list of sources that have referred visitors to the site, grouped by 'direct', 'organic', 'site' and 'social'. 'site', 'organic' and 'social' can be grouped by the engine/domain too. via GET /now/v3/sources

Retrieve group of sources -- Retrieves a specified group of sources such as 'site'. via GET /now/v3/sources/{sections}

Retrieve the time -- Retrieves the time according to the GoSquared infrastructure. via GET /now/v3/time

Retrieve a Time Series -- Retrieves a list of data points containing the number of visitors over time as the metric. This can be used to plot visualisations of visitors over time as shown in the Now dashboard. It could also be used to retrieve information for further analysis elsewhere. via GET /now/v3/timeSeries

Retrieve online visitors -- Retrieves a list of online visitors with information relevant to them and the pages that they are visiting. via GET /now/v3/visitors

Retrieve a visitor -- Retrieves information for a specific visitor via GET /now/v3/visitors/{visitorID}

Retrieve a list of all devices -- Retrieves a paginated list of every device that has ever been tracked in People CRM. If you only need a list of devices used by a specific person, use this endpoint instead. via GET /people/v1/devices

Retrieve a device -- Retrieves the details (platform, browser, user agent, screen size, ISP, location, total visits etc) of a single device using the deviceID . Note: If you just want to know the details of the most recent device somebody used, you can first retrieve the person . You'll then find their most recently used deviceID in the last object under the device field. via GET /people/v1/devices/{deviceID}

Retrieve a list of event types -- This method is useful for understanding what events have been tracked in People CRM. It returns a list of events ordered by the count of how many times it has been tracked. To see the list of events for an individual Person please see Retrieve a feed of events for a Person via GET /people/v1/eventTypes

Search for a list of people -- This endpoint gives you access to the powerful search and filtering abilities of People CRM. Filters You can filter the list of returned People using the filters parameter, giving you the ability to fine-tune your query based on the rich tracking information stored in GoSquared. Results can be filtered on events (see Event Types ) or properties (see Property Types ). The filters parameter can be complex so we advise that you look at an existing Smart Group to begin with to see how your pre-existing Smart Groups filter results. Using the Query Builder on the right you can graphically build up a filters object using any combination of filters. You can then see the Example Request below with the generated json query. For reference, when using filters key will be element you are filtering on, either a property or event. Path will be the specific property or event you are filtering on, for example for a property that could be 'email'. Operator will be the notation or criteria for that path, such as 'contains'. Value will be the specific value of that path you are filtering on. For example, if wanted to build a filter for any users with an email containing 'GoSquared', it would be as follows: key : 'property' path : 'email' operator : 'contains' value : 'GoSquared' via GET /people/v1/people

Retrieve a person -- Retrieve a single profile from People CRM by its person_id . This will return a list of all the properties that have been set on the profile. via GET /people/v1/people/{personID}

Retrieve a list of devices for a person -- Retrieves a paginated list of devices that a specific person has used. The devices are returned in chronological order based on when the device was last used (sorted newest to oldest). via GET /people/v1/people/{personID}/devices

Retrieve a feed of events for a person -- Retrieves a list of tracked events associated with a Person in reverse chronological order. This list can be filtered based on the type for event s, which are events that you have tracked, and sessionEvent s - GoSquared tracking events such as pageviews and session beginning and endings. You can also specify a date range to filter for. The query parameter allows you to search through a Person's event history based on the name of the event via GET /people/v1/people/{personID}/feed

Retrieve all property types -- Retrieves a list of all types of properties that exist in People CRM. The property names use dot notation where a . represents a property so last.location.coordinates represent the object below in a returned Person object. { "...": "...", "last": { "location": { "coordinates": "..." } } } via GET /people/v1/propertyTypes

Retrieve a property -- Retrieves a single property by name via GET /people/v1/propertyTypes/{propertyID}

Retrieve all custom property types -- The same as above but only returning custom properties. via GET /people/v1/propertyTypes/custom

Retrieve all Smart Groups -- A Smart Group is a filtered list of users that has been saved in People CRM. This endpoint retrieves a list of all the Smart Groups associated with a specific project. It also returns the filters that have been applied to each Smart Group. via GET /people/v1/smartgroups

Retrieve a Smart Group -- Retrieves a single Smart Group by its groupID . The groupID is usually the lower-case name of the Smart Group. You can check the groupID by viewing the URL path that links you to the group in the People dashboard. via GET /people/v1/smartgroups/{groupID}

Retrieve a feed of events from everyone in a smart group -- Requests an export of all pageview activity of users in a smart group into a downloadable CSV. The response contains a link to download the CSV. This link is active for 15 minutes, after which it will expire. A maximum of 60 days' worth of data can be queried at a time. Longer time ranges can be broken down into multiple smaller requests. via GET /people/v1/smartgroups/{groupID}/feed

Retrieve a list of people in Smart Group -- Retrieves the list of people in a given Smart Group. This function is the equivalent of mapping the Smart Group's 'filters' property to the Search People method. Using the query parameter you can search through this smartgroup via GET /people/v1/smartgroups/{groupID}/people

Retrieve historical aggregate data -- Retrieves a list of summarised aggregate metrics over a given time period. This data powers the trends timeline and total metrics. These data points can be split up using the interval parameter for performing finer calculations over time. via GET /trends/v2/aggregate

Retrieve historical browser data -- Retrieves a list of summarised browser metrics over a given time period. via GET /trends/v2/browser

Retrieve historical country data -- Retrieves a list of summarised country metrics over a given time period. via GET /trends/v2/country

Retrieve historical event data -- Retrieves the number of times that an event has been triggered over a given time period. The data property passed when tracking events is not included and can instead be found in the Feed API. via GET /trends/v2/event

Retrieve historical language data -- Retrieves a list of summarised language metrics over a given time period. via GET /trends/v2/language

Retrieve historical organisation data -- Retrieves a list of summarised organisation metrics over a given time period. via GET /trends/v2/organisation

Retrieve historical operating system data -- Retrieves a list of summarised operating system metrics over a given time period. via GET /trends/v2/os

Retrieve historical page data -- Retrieves a list of summarised page metrics over a given time period. via GET /trends/v2/page

Retrieve historical base path data -- Retrieves a list of summarised base path metrics over a given time period. via GET /trends/v2/path1

Retrieve historical screen dimensions data -- Retrieves a list of summarised screen dimensions metrics over a given time period. via GET /trends/v2/screenDimensions

Retrieve historic Sources data -- Retrieves a historical list of sources that have referred visitors to the site, grouped by 'direct', 'organic', 'site' and 'social'. via GET /trends/v2/sources

Retrieve sources by group -- Retrieves a historical list of sources for the given section. via GET /trends/v2/sources/{sourceType}

Update blocked bots setting -- Updates whether the automatic bot blocking feature should be turned on/off for a given project. via POST /account/v1/blocked/bots

Update blocked IPs -- Updates the list of IP addresses to be blocked for a given project. via POST /account/v1/blocked/ips

Update blocked visitors -- Updates the list of blocked visitors for a given project. via POST /account/v1/blocked/visitors/{visitorID}

Add a team member -- Adds a user to the list of shared users based on their email address. If the given email address is not associated with a GoSquared account then they will be invited to create an account and gain access to the shared project. Note: Only API keys generated by the project owner have permission to be used with this endpoint. via POST /account/v1/sharedUsers

Add a site -- Adds a new site to GoSquared tracking. This endpoint allows the programmatic creation of sites to be tracked with GoSquared. It is important to note that this does not mean the site is now being tracked. You must still include our tracking code, or use one of our client libraries, to track information from the added site. The response body will contain the details for the created including its site_token. This site_token can then be used as part of you application flow to enable tracking on the added site. via POST /account/v1/sites

Add a tagged visitor -- Adds a tag to an identified visitor. via POST /account/v1/taggedVisitors/{visitorID}

Add a webhook -- Adds a webhook. via POST /account/v1/webhooks

Add a trigger to a webhook -- Add a trigger to a webhook. via POST /account/v1/webhooks/{webhookID}/triggers

Archive chat -- Archive a chat conversation. via POST /chat/v1/chats/{chatID}/archive

Send a message -- Send a message to a person as an agent or client. When sending a message as an agent, the agent will be set to the owner of the API key. To send a message as a client, you will need to include their "Person Signature" as the "auth" value in your query params. The "Person Signature" should be generated on your server by combining the user's unique identifier with your project's Secure Mode Secret using a SHA-256 HMAC function (keyed-hash message authentication code.) via POST /chat/v1/chats/{chatID}/messages

Leave a note -- Leave a note in a conversation. via POST /chat/v1/chats/{chatID}/notes

Un-archive chat -- Un-archive a chat conversation. via POST /chat/v1/chats/{chatID}/unarchive

Add a Smart Group -- Add a new Smart Group. Filters You can use filters to create the criteria for a smart group to add using the filters parameter, Smart Groups can be built around events (see Event Types ) or properties (see Property Types ). The filters parameter can be complex so we advise that you look at an existing Smart Group to begin with to see how your pre-existing Smart Groups filter results. Using the Query Builder on the right you can graphically build up a filters object using any combination of filters. You can then see the Example Request below with the generated json query. For reference, when using filters key will be element you are filtering on, either a property or event. Path will be the specific property or event you are filtering on, for example for a property that could be 'email'. Operator will be the notation or criteria for that path, such as 'contains'. Value will be the specific value of that path you are filtering on. For example, if wanted to build a Smart Group of any users with an email containing 'GoSquared', it would be as follows: key : 'property' path : 'email' operator : 'contains' value : 'GoSquared' via POST /people/v1/smartgroups

Track an event -- GoSquared events are a versatile way of tracking anything that is happening on your site or app. User actions, application errors, state transitions, and activity of all kinds can be tracked as an event. Popular events are aggregated by name in the Trends dashboard . You can search and filter by the top level event name in People CRM . Optionally, you can include extra data in the event body. However, event body data is not currently searchable , but it can be viewed on a per profile basis in People CRM. How many unique event types/names can I track? Take some time to think about the name you give to your events. You can name them anything you like, but it's best to use a clear, concise name. Each GoSquared project can track up to 1000 custom events . Above this limit, events with new names will be ignored. via POST /tracking/v1/event IRREVERSIBLE: tracked data cannot be removed from GoSquared dashboards, so an event sent to the wrong project pollutes its analytics permanently.

Track a pageview -- Pageviews are used to track what pages a visitor is browsing across your site. A visitor can visit any number of pages during a browsing session, and these will be automatically tracked using the JavaScript tracker so long as it is installed on every page. We also use ping requests to tell our tracking systems that the visitor is still on that page - if we do not receive a successful ping for 30 seconds then they will be timed out. Pageviews can currently only be tracked via the JavaScript tracker or direct via HTTP, and not with any other libraries. via POST /tracking/v1/pageview IRREVERSIBLE: tracked data cannot be removed from GoSquared dashboards, so a pageview sent to the wrong project pollutes its analytics permanently.

Ping the tracking session -- In order to know that a user is still on your website, a ping must be received at least once every 30 seconds. If no ping is received then the session will be timed out. Note : This function is primarily useful for building custom libraries or advanced tracking processes. In the vast majority of cases the library for your language or the tracking code will manage pinging GoSquared for you. via POST /tracking/v1/ping IRREVERSIBLE: session pings extend live sessions in analytics that cannot be edited afterwards.

Track some properties -- Properties are an excellent way of getting to know your users. They contain user information and state. All properties can be used to search, filter and sort your users in People CRM . The more you track, the better you can understand your users. GoSquared defines a list of common properties that are useful to track. Some of these special properties are used by GoSquared to provide powerful functionality. For example, email is used to look up additional information about an individual from publicly available sources. Custom properties Besides special properties, you can track any property of any data type and GoSquared will make that data searchable, sortable and filterable. Place your custom properties under the custom property. People CRM needs to know about what kind of data each custom property contains – whether the property is text, a number, or a date etc. Therefore, when you track a custom property, it is automatically assigned a “type” based on the value you send. We can can then make sure the data is searched, sorted and filtered in the correct way for that data. Possible types are Text , Number , Date , Boolean and Null . For example, if you send a subscription_created property with a value like 2015-03-03T15:00:00+00:00 , it will be assigned the Date type. Alternatively, if you send a subscription_value property with a value like 49.99 , it will be assigned the Number type. Date detection is fairly lenient, so long as it resembles at least a portion of an ISO 8601 string. People CRM will always try its best to figure out the most appropriate type for your custom properties. Sometimes it’s not always possible to get it exactly right, such as if you send a numeric Unix timestamp and want it treated as a date. In those cases, you can manually correct the property type in your Project Settings . Once a custom property is tracked, it will appear in the custom properties list in the People section of Project Settings . There, you can manually change the type of the custom property. This might be necessary if you track a custom property with the wrong data, or if you wish to change what the custom property is used for. How many different custom properties can I track? Each GoSquared project can track up to 1000 custom properties . Above this limit, properties with new names will be ignored in that project. via POST /tracking/v1/properties IRREVERSIBLE: tracked properties cannot be removed from GoSquared dashboards once recorded against a session.

Timeout the tracking session -- Calling this function will end all sessions for the given Visitor. If the page.index value is given then it will only timeout that session. via POST /tracking/v1/timeout IRREVERSIBLE: timing out a session ends it in analytics that cannot be edited afterwards.

Track a transaction -- Transactions are a special type of event, used to track when a user has purchased something from you. The data is reported in Ecommerce Analytics and People CRM . Transactions can be tracked either in the browser using the JavaScript Tracker when a user completes a purchase, or on the backend when your application processes the transaction. If a transaction ID is specified, it will be checked for uniqueness to prevent duplicate transactions from being tracked. By default, GoSquared calculates the total revenue and quantity amount from the items in the transaction. You may want to override this in some cases, such as when a discount was applied. This is possible by specifying revenue and quantity totals in the transaction options. Note: It is not possible to remove test transactions from your Ecommerce dashboard. Therefore we highly recommend creating a test project in your GoSquared account before you start sending data to your production project. via POST /tracking/v1/transaction IRREVERSIBLE: tracked data cannot be removed from GoSquared dashboards, so a transaction sent to the wrong project pollutes its analytics and revenue figures permanently.