Beta - Qualtrics API Guide

BETA - Data Acquisition - APIs

Welcome to the beta release of Qualtrics API data source! This guide will provide you with the information you need to get started with ingesting data from Qualtrics API.

Overview

The Qualtrics API Data Source allows you to fetch data from Qualtrics via their API connector. This beta release is intended to gather feedback and iterate on the way One Model connects to the Qualtrics API before the official launch.

Creating a Qualtrics Data Source

Create a data source:

Configure the Data Source

Fill in the required information for the data source including the Qualtrics API authentication information - Endpoint Base URL, Client ID, and 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.

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

 

 

Creating and Obtaining Client ID and Client Secret in Qualtrics

  1. Login to qualtrics.com then select Account Settings.Account Settings.png
  2. Navigate to Qualtrics IDs
  3. Then select OAuth Client Manager.
  4. Click Create Client.
  5. Enter name and contact information as shown below.
    create_modal_open.png
  6. Next, choose scopes from the dropdown, either by finding them in the list or searching for them.
    create_modal_choose_scopes.png
  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.
    create_modal_choose_grant_type.png
  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. 

         Screen Shot 2019-01-14 at 5.54.02 PM.png

 

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 for Beta. 

 

Feedback Form

We invite our beta-testers to complete this feedback form to share what they liked about this feature, any bugs they encountered, and suggestions for future development.  

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.