Getting Started with Qualtrics Public Collections
Welcome to our public collections, which offer an easy and comprehensive access point to explore all our public APIs.Qualtrics REST API is a Paid Feature
The Qualtrics API is a paid feature that provides API access to products in your Qualtrics license. Check with your Qualtrics Administrator to see if your account is licensed. Administrators who need information about API licensing should contact their Qualtrics sales representative.Required Qualtrics Account Information
With an active Qualtrics account, you have API Key and Datacenter ID.You'll use both to set up your environment in Qodex.
See Finding Your Qualtrics IDs for more information.
Base URL and Datacenter IDs
The base API url consists of the qualtrics hostname for your organization followed by/API The scheme must be https. The format of the URL is: https://{yourdatacenterid}.qualtrics.com/API
If we use the example Datacenter ID, ca1 from the previous image, our base URL is: https://ca1.qualtrics.com/API
See Base URL and Datacenter IDs for more information.
Set up your environment
By setting up an environment within a Qodex workspace, you can greatly simplify tasks like Authentication or entering the base URL for an API request. We recommend that you use a workspace without any existing API collections or create a new workspace to fork Qualtrics API collections into. By keeping Qualtrics APIs in their own workspace, you'll be able to tailor your experience by adding your own environmental variables (for example, youruserId).
This guide details how to create an environment in your Qualtrics workspace that sets your API Key and Datacenter ID as environmental variables.
Note: You can set your environment variables before or after forking collections into your workspace. This guide shows creating the workspace and setting the environment variables before forking collections, but the order is not important
- Install the [Qodex app]
- Launch Qodex.
- Select the workspace you wish to use for the Qualtrics collections. Create a new workspace if needed.
- In the upper-right corner, select the box listing the environments. The initial value is No Environment if you're using a new workspace or if you just installed Qodex.
- In the upper-right corner, next to No Environment, select Environment quick look., and select Add in the Environment field.
- Give the environment a recognizable name.
- Now add your Qualtrics base URL as a variable. Use the URL associated with your data center. For example:
https://ca1.qualtrics.com/API. AddbaseUrlas the variable name and set the Initial Value and Current Values ashttps://ca1.qualtrics.com/API.
- For the API Key variable, in the Initial Value and Current Value columns, input the API token that you created earlier, for example:
00LzMWxMq_0sdErHy9Jf1sijEGexYZlsdGr9a4QjkS. - Select Save.
Fork a collection
To find our public collections, you can search for the Qualtrics Public APIs from within Qodex, or visit our Fork Qodex Collections page to fork or import a collection. Select Run in Qodex to fork an API collection:
On the next screen, select Fork Collection to fork the Qualtrics collection to the workspace you've created for Qualtrics APIs. (You can also import the collection or view it first).
