Skip to main content

Gain insight into your customer's activity

This page applies to:MindTouch Responsive

Take full advantage of MindTouch functionalities and integrate MindTouch Insights into your existing customer relationship management (CRM) or customer engagement management (CEM) systems to learn how to provide the best support possible to your customers. With MindTouch Insights, agents can instantly see a full history of customer view and search activity across their MindTouch site. The primary benefits include:

  • Understand context: Agents have insight into exactly which articles your customers searched before filing their cases and are able to provide the informed, focused and comprehensive support your customers need. 
  • Avoid repetitive information: Looking for help can be quite frustrating to a customer. And while you are already doing everything possible to ease your customer's frustrations, integrating MindTouch Insights further helps to get your customers to their happy place. With MindTouch Insights agents can confidently send articles to your customers haven't looked at yet.
  • Verify content accuracy: Agents can re-visit an article with a customer and verify if steps provide accurate and adequate information to help the customer be successful. If content is lacking, agents can request updates to be made to improve the customer's self-service experience.
  • Identify gaps in self-service: Agents can identify whether relevant search results were clicked and can suggest new search recommendations that should be presented to your customers when searching for a particular term. Analyzing content gaps and proactively providing solutions enhances self-service and customer engagement with your site instead of with your agents.  
  • Lower costs: Agents improve their mean time to resolution (MTTR) by quickly identifying what the customer is trying to accomplish.


Key features

This sample configuration brings the power of MindTouch Insights into your CRM/CEM. The key features for agents include:

  • Instant access to customer history (loaded when the case is opened).
  • Quick access to the exact searches and pages performed by clicking the link.
  • Detailed information about the exact date (and time) a customer performed the request.


Prerequisites for integrating MindTouch Insights

In order to set up the Insights integration, you should have the following:

  • A CRM/CEM that can run HTML code
  • Basic familiarity with Javascript
  • Basic familiarity with CSS (if styling customization is desired)

Integrate MindTouch Insights

This section outlines the steps for a sample integration with MindTouch Insights.  

Step 1: Download the sample code

Download this sample file to your computer.

Step 2: Set configuration variables

The sample code is configured to use the MindTouch Success Center at In the top of the file, modify the following settings:

var MindTouch = {};
MindTouch.SITE_URL = "";
MindTouch.CUSTOMER_ID = '';
  • SITE_URL – the URL of your MindTouch site (connect to the HTTPS version of the site, since most CRM/CEM systems are HTTPS).
  • CUSTOMER_ID – the username (or anonymous session ID) of the customer. The customer username is a more reliable way to track activity between sessions.
Step 3: Enable customer history tracking
  • Ensure you are logged in as a pro member with USERHISTORY permissions enabled for the site (can be enabled via the API or contact MindTouch support to configure a specific pro member role with USERHISTORY enabled). You can then add users with that role to a group. When enabled, verify that you can view the User Activity Report and look up the history for a customer.
  • Next, ensure the CUSTOMER_ID is available in your case management system. Although MindTouch provides anonymous session IDs as part of the integration workflow, it is best to provide the username of the customer. (Using SSO, your customers can automatically log into MindTouch).

Note to user   NOTE:  Using the customer username provides better tracking and avoids the risk of losing information if the customer changes browsers or clears browser cookies, which would clear the anonymous session. Learn more about the customer activity API.

Step 4: Integrate the code with your CRM/CEM software

The last step is to integrate the code into your CRM. Using the HTML widget functionality, copy the widget HTML code into the appropriate location. A few caveats:

  • Single sign-on (SSO): The search widget uses the API, and no SSO is performed. If the user has an existing session with MindTouch, it will be re-used by these API requests (read more on configuring SSO with MindTouch here).
  • jQuery: The widget code uses a version of jQuery hosted by Google, and is stored as $j in noConflict mode. If the CRM/CEM has an existing jQuery library, it can be used instead.
        <!-- PREREQUISITE: jQuery -->
        <script src=""></script>
  • API Requests: The widget makes direct API calls using jQuery's $.ajax() function. If the CRM/CEM provides its own AJAX library, it can be used instead.
    var url = MindTouch.SITE_URL + '/@api/deki/events/support-agent/=' + customerId + '?dream.out.format=jsonp&dream.out.pre=?';
    var params = {
       limit: 50,
       include: "page,file",
       origin: MindTouch.WIDGET_NAME
  • Custom behavior: The code was written to be modular. The rendering of the interface can be easily modified to support a different look and feel.
  • Accessing the customer ID: When SSO is set up, the customer username is often the customer's email address. If a different system is in place, ensure the CRM/CEM has this as a variable that can be passed to the Insights widget.
  • Custom styling: The CSS at the bottom of the widget can be modified to restyle the widget. This code sample references the Font Awesome icon font to for the page and search icons. 


  • Was this article helpful?