Category: Voice of customer

This integration is only available for Web projects

What to expect

This integration will allow you to segment Qualtrics responders in Contentsquare based on their interactions and responses with Qualtrics feedbacks. Furthermore, you can further investigate Qualtrics user responses by exploring their session replay links attached as custom attributes.

What we collect

Dynamic Variables

Artificial Pageviews

In order to have artificial pageviews triggered for these options below, you will need to ask your Contentsquare CSM or Support to enable a feature which will allow these to be sent. Note that these are specifically for usage in the Journey Analysis module of the Contentsquare application.

What we send

Session replay

To properly make use of the replay feature you need to either have 100% collection ratio or ETR (Event Triggered replay), please talk to your CSM about this.

Limitations

General

Due to WebKit's official policy known as ITP (Intelligent Tracking Prevention) and Firefox's Enhanced Tracking Prevention, certain browsers block 3rd party cookies in iframes by default. If your survey appears in an iframe then by default we cannot support the following browsers or browser modes:
Safari 12+
Chrome 83+ (only in Incognito)
Firefox 67+ (only in private browsing mode)

The solution is to enable iFrames Tracking for Zoning in the Contentsquare project settings, talk to your CSM or Support about this.

Note that if your survey is in a window popup or a new tab then the above does not apply.

Qualtrics

If you are using the new "Simple" layout for your surveys then it will not support sending ratings and other question/answer data to Contentsquare. All other features are supported. If you want to send all of this data to Contentsquare then you will need to revert to using one of the other layout options such as "Flat" or "Modern". This is a Qualtrics limitation.

Also if you switch to the Simple Layout at any point in time then you will need to rename the Embedded Data item in the Survey flow to be: __js_ContentsquareReplayLink

Implementation

Implementation Steps

If you have already completed the step above then continue below.

Step 2

Setting Embedded Data

Depending on whether you are using the new Intercept configuration flow or the old, please see the relevant below.

For the old flow:

To enable this integration please go to your Website App & Feedback section in Qualtrics:

Go to Interepts

Pick the relevant survey and then click on the Embedded Data button

Define a new embedded data object like this:

CSID | Value from Javascript | sessionStorage.getItem("CSID")

Press save and publish those changes.

For the new flow:

If this is a new intercept then in the config you may see this, press Add Embedded Data:

Or if you already have an intercept set up then simply edit it here:

Then press the plus sign if you already have embedded data defined:

Then insert the values like this:

Value from Javascript | sessionStorage.getItem("CSID") | CSID

Setting The Contentsquare Tag

Please go to the survey you wish to track with Contentsquare.

Then click on the Look & Feel section, then on General and then the edit button under Header.

You may or may not already have content in this section but you will need to click on the Source icon.

Once in there, and depending on whether you already have content in there or not, you need to then add a snippet of HTML/Javascript code anywhere in there, best to be at the very top or very bottom so you can distinguish from other items in there.

Here is the Contentsquare tag below but you need to ask CS support for your CS tag ID. If you already have it then resume below.

Copy the code below and insert your Contentsquare Tag ID in the relevant section of the code which says REPLACE_WITH_TAG_ID. Make sure you keep the .js after the tag ID. 

<script>
Qualtrics.SurveyEngine.addOnReady(function () {
    (function () {
        if (!window.CS_CONF){
           window._cs_integration_qualtrics_csid = "${e://Field/CSID}";
		     
           var mt = document.createElement("script");
           mt.type = "text/javascript";
           mt.async = true;
           mt.src = "https://t.contentsquare.net/uxa/REPLACE_WITH_TAG_ID.js";
           document.getElementsByTagName("head")[0].appendChild(mt);
        }
    })();
});
</script>

Then paste the full code inside the Header HTML section.

After adding the code, it should look something like this:

Save that and Apply the changes.

Be sure to publish these changes in Qualtrics, otherwise the added script will not reflect in production.

 

Setting The Contentsquare Replay Link

Go to the Survey flow:

Depending on which survey layout you use will determine which name to add here.

If you use the non-simple layout survey then add a new Embedded Data item called ContentsquareReplayLink exactly like this:

However, if you use the simple layout survey then add a new Embedded Data item called __js_ContentsquareReplayLink exactly like this:

Save and publish those changes.

Sending Custom Dynamic Variables From The Survey

If you would like to send custom dynamic variables from the survey context with your own key/value pairs then all you need to do is copy and edit this code below and paste it into whichever survey questions are relevant for you. You can add it to multiple questions but make sure that each Key is unique.

All you need to edit are the string values of the 2 variables in the code:
var csKey
var csValue 

window._uxa = window._uxa || [];
_uxa.push([
    "afterPageView",
    function (context) {
        if (typeof window.CustomEvent === "function") {
            var csKey = "";
            var csValue = "";

            if (csKey && csValue) {
                var evt = new window.CustomEvent("Contentsquare_QT_Integration_Dispatcher", {
                    detail: {
                        key: csKey,
                        value: csValue,
                    },
                });
                window.dispatchEvent(evt);
            }
        }
    },
]);

You can then open the Javascript section of the relevant questions or questions and paste the code into there:

Please make sure you add it into the Qualtrics.SurveyEngine.addOnReady function.

It should then look something like this but with your own custom Key and Value strings. The Keys and Values can be dynamically generated using code too, as shown in the example of the Value below. We are taking the Survey ID dynamically and setting it as the Value (Page.runtime.ED.SurveyID). Note that we only accept string values in this. The max length of the Key can be 50 chars and the Value can be 255 chars.

If you are using the new "Simple" layout surveys then to get the Survey ID you will need to use this (window.q.appData.setup.survey.id) instead of what is shown above.

Please note that we have a limitation of 50 dynamic variables per page view so if you are already sending close to that then you may not receive additional ones you create. Best to check how many are being sent from your entire survey before adding more to it.

Verifying it works

You can use the chrome extension to check the results are sent to CS

In your Qualtrics account you will be able to see replay links if you have enough collection ratio set.

If your ratio is too low then please discuss it with your CSM.