Qualtrics API | XM Community
Skip to main content

Qualtrics API

Discuss API solutions, best practices, and more.

  • 1,043 Topics
  • 2,447 Replies
1043 Topics
B
BinhPM
asked in Qualtrics API
Get contact by recipient id

Hi everyone, Since API get contact list from sample version 3 has some issue at the moment, i have to use GetSampleContacts version 2.4 instead while waiting for Qualtrics support team, but it only return RecipientID, not ContactID. And i don't know what i can do with this id to get contact id as every other API required ContactID as their input. I tried to use GetContactByInfoFields version 2.4 too to find contact by email and external data. But some of my customer response doesn't have both email nor external data. So does anyone know other way to get ContactID from RecipientID. Thank you very much

1031
KendraR
Qualtrics Employee
5 years ago
J
judychen524
posted in Qualtrics API
How to set up an action and use Qualtrics API to create contacts?

Hi. I am just starting to figure out how to trigger survey action using web service; The first thing I want to try out is to setup a web service action that uses Qualtric's API to create contacts based on an email field in the survey. Can anyone help me figure out how to configure this? I know there is the contact list trigger, but I'd love to try it out with Q's API. !

421
TomG
Level 8 ●●●●●●●●
5 years ago
B
BinhPM
asked in Qualtrics API
Could not get contact from Sample, alway return empty list

Hi everyone. We need to get a list of contact with new response within a day. So we try to create a sample with lastResponse filter. Everything work fine for creating definition (Create Sample Definition) and sample (Perform Sample on MailingList/Batch). When we check on website, we see the newly created list with some contact that met our criteria. We call "Get Create Sample Progress" and got a 100 percent result. But when we call "Get Sample Contacts" API to get list of contact, we only receive an empty list. So anyone know why? Is there any step we miss? Thank for your help!

775
B
5 years ago
A
abechard
asked in Qualtrics API
Random Number from a Discrete Set

Hello all, I am new and have a question with the random number generator. I want to create a random number, from the set {5, 10, 15, 20} that appears in the question. The random number generator won't allow me to choose just these, as it only gives a min and max and thus all values between 5 and 20 are in play. Is there a way to go about this?

153
TomG
Level 8 ●●●●●●●●
5 years ago
A
akirillo
asked in Qualtrics API
OAuth system is broken!

Hey there! I'm trying to build an app that uses the Qualtrics API, using the OAuth2 authorization code grant type for authentication. I successfully request the authorization code, so I get to the page where the user is prompted to enter their Qualtrics login. Upon entering login credentials, though, I get the following error printed in the browser: `{"message":"Error - couldn't get consent request details for 4b1f0b61-0b54-4c87-8347-088f63bb45f3","requestId":"4c4529f0-9d26-11e9-a427-41709f29a65e"}` The URL where this is displayed is: `https://ca1.qualtrics.com/consent-app/oauth2/consent?consent=4b1f0b61-0b54-4c87-8347-088f63bb45f3` Also, I have assured that I am requesting an auth code from the same datacenter where my client is registered, and that the user under which my client is registered has API access, so these can't be the issues. Please offer any insight you can! I'm not sure where this error originates, but I can tell the OAuth flow is getting interrupted before redirect

2071
JenCX
Level 5 ●●●●●
5 years ago
U
Level 3 ●●●
uhrxx005Level 3 ●●●
asked in Qualtrics API
New to API, need help pulling ONLY specific variables from a survey

As far as I can tell, the API pull seems to be an all or nothing approach. Does someone have instructions for how to pull only certain variables using the API and not pull any extra information? Thanks in advance!

156
K
5 years ago
J
jingjingjing
asked in Qualtrics API
How to use API to set up recurring email and SMS reminders?

Hi everyone, I'm completely new to API and programming in general. For our survey, we want participants to take it via an anonymous link twice a day for a month, so we want to set up an automatic email and SMS reminders for them to take the survey. I know that can be accomplished using API, but I have no idea how to get started. Thank you so much for your help!

874
J
5 years ago
J
jamieyou
posted in Qualtrics API
Do we have API's for retrieve the survey responses scoring ?

Hi I am wondering where I can find the rest api for retrieving the survey responses report with scoring as json ? what I find for now just export the responses results as json

221
Akdashboard
Level 4 ●●●●
5 years ago
V
vshalamov
asked in Qualtrics API
Create a survey link for specific session ID

Hi All Is there a way to specify session ID in survey link? I'm able to create session thru API and I want to get a link for that specific session. I tried adding ?SID=<sessionId> to Anonymous Survey Link but that didn't work Best regards, Vlad

3467
KendraR
Qualtrics Employee
5 years ago
M
meenakshi_singh12
posted in Qualtrics API
Deprecation of Legacy Response Exports v3

Hi, It is mentioned "Deprecated" for 3 API of Legacy Response Exports(https://api.qualtrics.com/reference#get-brand-info). Could you please guide when they are planned to be decommissioned. Thanks, Meenakshi

150
M
5 years ago
E
etower
asked in Qualtrics API
Is it possible to export directly to Oracle?

We are building an Oracle database to house longitudinal data from multiple surveys per year (each survey is 90% identical). Is it possible to use the Qualtrics API to export data directly into Oracle? Thanks!

611
KendraR
Qualtrics Employee
5 years ago
D
DLudgin
asked in Qualtrics API
API to Collaborate with Groups instead of Users

I have an API to setup automatically collaborate with users, but we need to set it up to collaborate by group in order to adjust collaboration settings on a large scale. I did try the setup using groupId instead of userId and that fails. I also tried putting the group Id for userId and that fails as well. Any ideas? !

421
KendraR
Qualtrics Employee
5 years ago
T
tonyk999
asked in Qualtrics API
Tableau API

I need to get the Qualtrics API ID so that I can test whether this could be a solution for connecting from Tableau. Also, what is the pricing for this? Tony

172
AMLS
Level 1 ●
5 years ago
J
jnm
asked in Qualtrics API
Is there a time delay in downloading responses to Survey?

I am trying to set up an integration between a Qualtrics survey and an RShiny app. The intention is that upon completion of the survey participants are redirected to a Shiny app for immediate feedback using their ResponseID to match. It generally works - the Shiny app is able to download the survey responses directly from qualtrics and provide the kind of reporting I intend. However, it seems that it takes quite some time (15 minutes perhaps?) between a response being recorded (and being available to download manually for example) and the response also appearing when I download the survey through the API (using the qualtRics package). Is this delay normal or is something going wrong on my side? What could be reasons if the latter?

2461
A
QPN Level 2 ●●
5 years ago
w.patrick.gale
Level 3 ●●●
w.patrick.galeLevel 3 ●●●
asked in Qualtrics API
Embedded data field types (how are they defined)

I am looking at the API documentation for adding embedded data fields to my surveys https://api.qualtrics.com/reference#insert-embedded-data-fields and would like to know what the different types of 'Valid embedded data field types' mean for the embeddedDataFields parameter? It isn't clear if data must be in a specific format to be saved to these embedded data field types or if it is simply for 'tagging' purposes and does not constrain the data in any way with regards to format or data length. When adding embedded data fields through the survey flow there is no option that I am aware of to set the field types. On a side note, I see we are allowed to have multiple copies of an embedded field in the survey flow (as shown in the screenshot below). I tested adding data to the survey to populate the 'MiscJson' embedded data field and only one copy of the embedded data field appears in the response data, which is good, but makes me wonder about the point of having the embedded data field

10076
w.patrick.gale
Level 3 ●●●
5 years ago
R
Rajneesh
asked in Qualtrics API
Can we connect Qualtrics Dashboard Directly through API's with Tableau?

Can we connect Qualtrics Dashbaord through API with Tableau instead of Qualtrics Survey.

681
KendraR
Qualtrics Employee
5 years ago
W
Winson
asked in Qualtrics API
How to enable the API feature for trial account with no expense ?

I was asked to do some research for the integration with Qualtrics. I have registered a free-account without the API feature. I was told that I can contact to the Brand Administrator to help me enable the API feature, but I can not find the BA contact info on the page. So, could someone help me to solve this question ? Thank you.

1951
JenCX
Level 5 ●●●●●
5 years ago
D
dpadilla
asked in Qualtrics API
Set question score using Javascript/API

I am using JS to score questions in a Qualtrics survey. Each question has 4 choices (radio buttons). The student gets to select as many of these as they want, but their score is lowered by 1 for each wrong choice. What I'm having trouble with is pushing this final score into the survey. The API has a setChoiceAnswerValue() function, but I can't find any examples of this in use (even after a Google search). Has anyone done this, and if so, how? Thanks.

2414
D
5 years ago
w.patrick.gale
Level 3 ●●●
w.patrick.galeLevel 3 ●●●
posted in Qualtrics API
Setting embeddedData parameter in Update Response API call (v3) - only existing embedded data fields

When working with the Update Response API call (https://env.qualtrics.com/API/v3/responses/responseId) the embeddedData parameter seems to only set embedded data fields that appear in your survey flow. You cannot set a {"IgnoreResponse":"true"} embedded data field through the API call unless a 'IgnoreResponse' embedded data field is already set in your survey flow. (I thought I would post this note since the API documentation does not make this clear.) I ran across this behavior because I was creating new versions of responses via the qualtrics.com/jfe/form/[surveyId]?Q_R=[responseId to update] call. This allows me to keep the original response, but create a copy that needs corrections. Having multiple copies of a response however caused a problem with my reports. I wanted to keep all revisions of my responses for audit purposes but also ignore the old responses in my reports. To do this I needed to add embedded data to ignore the older responses. I decided to add a 'MiscJson

1290
w.patrick.gale
Level 3 ●●●
5 years ago
H
Level 1 ●
HelgiLevel 1 ●
asked in Qualtrics API
How to use API in R (without using packages such as qualtRics)

Hi I used to use API v2 for some tasks with our contacts. Now I'm not sure how I should construct my calls in R after they upgraded to v3, the 'Try' button on their API page isn't even working. Any help would be greatly appreciated. -Helgi

291
H
Level 1 ●
5 years ago
H
hugoanda
asked in Qualtrics API
How to export files from surveys?

Hi Qualtrics experts, I am designing a script to download the survey responses using the API, and then I have to upload those responses to another system. However, I found an issue while retrieving all the information from the responses. I thought that once that you retrieve all the information of a survey, or you get a specific response, all the data will be downloaded. But the problem is that if there is an image, the API will not be able to download it. Unfortunately, my survey has some questions that make the participant draw something. Those responses get saved in Qualtrics as jpeg files with a specific ID, something like F_XXXXXX. So, does anyone know how can I retrieve those pictures?

1942
H
5 years ago
w.patrick.gale
Level 3 ●●●
w.patrick.galeLevel 3 ●●●
asked in Qualtrics API
Is the 'Try it' function in the Qualtrics API no longer working?

I wanted to test the API function https://api.qualtrics.com/reference#create-response-export-new but I received a '400 bad request' error with 'Cannot download response export file through datacenter proxing, please retry using the url of the datacenter the API user belongs to.' The problem is there is no way for me to enter the datacenter ID in the 'Try It' editor and the documentation on the Try It editor seems to be out of date on the support site.

93
w.patrick.gale
Level 3 ●●●
5 years ago
U
Level 3 ●●●
uhrxx005Level 3 ●●●
posted in Qualtrics API
API for dummies (non-programmers)

Does anyone have a guide they would be willing to share for setting up basic API functions without having any programming/coding experience? Thanks! David

143
TomG
Level 8 ●●●●●●●●
5 years ago
w.patrick.gale
Level 3 ●●●
w.patrick.galeLevel 3 ●●●
asked in Qualtrics API
API version 3 (something) response exports

Is there a way I can make a call to export-responses and get the JSON data in the 'older' v3 format so it matches my existing data? I just spent the day testing /API/v3/surveys/SV_012345678912345/export-responses and comparing it to 'the older v3' of /API/v3/responseexports using the JSON format. The JSON output is completely different and incompatible. I have a QID4 question ID that shows up as QID4_TEXT using the newer export-responses API call and that ID does not even exist in my survey template file. That is a problem since I am mapping the survey configuration (.qsf) template with export data from the API and it totally throws off my code. The only reason I was testing the newer API call is because the older version does not seem to pull response edits (only the original survey responses).

392
w.patrick.gale
Level 3 ●●●
5 years ago
S
sherafghan
asked in Qualtrics API
Sequential Blocked Randomization

Hi there, I am trying to assign subjects to one of the 10 treatments (as they arrive) based on information that they provide at the beginning of the survey. So in the beginning, I collect information on race, age, gender, education, etc. and then I want to make sure that these covariates are balanced across treatments. I came across this paper which goes into using rpy2 API using Qualtric Web Service for achieving this. However, for some reason, I can't get to make this method work (Qualtrics does not set an embedded field even after the Web Service is run). My question, is there another way of doing sequential blocked randomization in Qualtrics? Or if somebody here has done blocked randomization in Qualtrics using rpy2 or any other method?

161
A
5 years ago

Motivational Playlist

Terms & Conditions