Qualtrics API Guide

The Qualtrics API Data Source allows you to fetch data from Qualtrics via their API connector. This guide provides you with all the information you need to get started with ingesting data from Qualtrics API.

To keep your instance running smoothly with the most up-to-date Qualtrics data, we recommend running a regular weekly full (destructive) run.

Creating a Qualtrics Data Source

The first step is to add the Qualtrics API to your data sources. 

1. Go to the Data tab in the main navigation menu, scroll down and select Sources. 
2. On the Data Sources page, click Add Data Source at the top right and scroll down to select Qualtrics. 

Configure the Data Source

Fill in the required information for the data source including the Qualtrics API authentication information including: 

• Endpoint Base URL
• Client ID
• Client Secret

Please see the guide below on how to obtain the required information from Qualtrics.com.

Obtaining the Endpoint Base Uri:

The Endpoint Base Uri is the qualtrics hostname for your organization.

Example base url: https://yourdatacenterid.qualtrics.com

Finding your Datacenter

1. Login to your Qualtrics account
2. Go to your Qualtrics IDs page. 
3. Click on the user settings icon in the top-right corner of your account.

3. Select Account Settings.
4. Click Qualtrics IDs on the navigation bar. 
5. In the User box, find your datacenter ID.

Your Endpoint Base Uri should be in the following format (replace bracketed values in URL with your brand's information): https://{yourdatacenterid}.qualtrics.com

  Creating and Obtaining Client ID and Client Secret in Qualtrics

1. Login to qualtrics.com then select Account Settings.
2. Navigate to Qualtrics IDs
3. Then select OAuth Client Manager.
4. Click Create Client.
   
5. Enter name and contact information as shown below.
   
6. Next, choose scopes from the dropdown, either by finding them in the list or searching for them.
   
7. Select these scopes: read:survey_responses, read:surveys, read:users by clicking on the scope in the dropdown. Continue for all the scopes you wish the client to have.
   
8. Select Grant Type: Client Credentials.
   
9. Click Create Client.
10. Write down the Client ID and Client Secret and store them in a secure location as you cannot access this information later. 

Configurable Tasks Description

• Questions 
  • returns a list of survey questions
• Survey Metadata
  • returns the survey metadata.
• Survey Responses
  • returns the survey responses.
• Users
  • returns a list of all users in the collection on your Qualtrics site.

Entity Relationship Diagram (ERD)

Below is the ERD of the tables generated.  

Troubleshooting

Q: I created a new survey but the new survey data isn't coming across to One Model, what should I do? 
A: Try running a full (destructive) load, and if it is still not working, check the permissions of the existing user - adjust or re-create with the additional survey included then re-run a full (destructive) load.