Qualtrics

Welcome to the Qualtrics documentation for Dimension! Integrating Dimension into your Qualtrics application is quick and easy.

If you have any questions, comments, or suggestions, please feel free to contact us.

Set Up Qualtrics API Access

Create an API Token in Qualtrics:

• Log into your Qualtrics account.
• Navigat to the 'Account Settings' and create an API token.

• Note down your API Token and Data Center ID.
• See here for more detail

Fetch Survey Responses from Qualtrics

Set Up GET Request:

https://yourdatacenterid.qualtrics.com/API/v3/surveys/{surveyId}/responses

These are the necessary Headers:

• X-API-TOKEN: {YourAPIToken}
• Replace {YourDataCenterId} with your Data Center ID and {surveyId} with the ID of the survey.
• Send the request to get the survey responses.

POST responses to Dimension

When your survey receives a response, post the data to the following endpoint:

https://tracker.dimensionlabs.io/track?platform=universal&v=10.1.1-rest&type=incoming&apiKey=API_KEY_HERE

Make sure to set the ‘Content-Type’ header to ‘application/json’ and to replace API_KEY_HERE with your api key.

You must send the data with the following fields:

• text – string – (required)
• userId – string – (required) – should be the SAME userId for both incoming and outgoing messages this is NOT the bot’s user ID

To review all optional fields see our API reference.

The data to POST should pass the following data:

{
  "text": "Hi, bot",
  "userId": "+14155551234",
  "platformJson": {
    "whateverJson": "any JSON specific to your platform can be stored here"
  }
}

Sample cURL

curl -X POST -H "Content-Type: application/json"
     -d '{"text":"Hi, bot","userId":"+14155551234","platformJson":{"whateverJson":"any JSON specific to your platform can be stored here"}}'
     'https://tracker.dimensionlabs.io/track?platform=sms&v=11.1.0-rest&type=incoming&apiKey=API_KEY'

Notice, you must replace the placeholder API_KEY_HERE above with your api key.

NPM Integration with Node.js

Steps

1. Set Up Node.js Project:

   • Initialize a new Node.js project: npm init.
   • Install required packages: npm install axios dotenv.

2. Environment Setup:

   • Create a .env file in your project directory.

   • Add your Qualtrics API token and Survey ID:

     makefile

     makefileCopy code
     QUALTRICS_TOKEN=yourAPIToken
     SURVEY_ID=yourSurveyId
     
     

3. Retrieve Data from Qualtrics:

   • Create index.js and set up Axios for API requests.

   • Fetch survey responses using Qualtrics API:

     JSX

     javascriptCopy code
     require('dotenv').config();
     const axios = require('axios');
     
     const qualtricsApi = axios.create({
       baseURL: 'https://yourdatacenterid.qualtrics.com/API/v3/',
       headers: { 'Authorization': `Bearer ${process.env.QUALTRICS_TOKEN}` }
     });
     
     const getSurveyResponses = async () => {
       try {
         const response = await qualtricsApi.get(`surveys/${process.env.SURVEY_ID}/responses`);
         return response.data;
       } catch (error) {
         console.error('Error fetching survey responses:', error);
       }
     };
     
     getSurveyResponses().then(data => console.log(data));
     
     

4. Send Data to Dimension:

   • Extend the script to send data to Dimension.

   • Add Axios configuration for Dimension API:

     JSX

     javascriptCopy code
     const DIMENSION_API_KEY = 'yourDimensionApiKey';
     const dimensionApi = axios.create({
       baseURL: 'https://tracker.dimensionlabs.io/track',
       params: { type: 'generic', apiKey: DIMENSION_API_KEY }
     });
     
     const sendDataToDimension = async (data) => {
       try {
         await dimensionApi.post('', { text: data });
         console.log('Data sent to Dimension');
       } catch (error) {
         console.error('Error sending data to Dimension:', error);
       }
     };
     
     // Example usage
     getSurveyResponses().then(data => sendDataToDimension(data));
     
     

5. Run and Test:

   • Execute your script: node index.js.
   • Check Dimension to confirm data reception.