Qualtrics API | XM Community
Skip to main content

Qualtrics API

Discuss API solutions, best practices, and more.

  • 1,070 Topics
  • 2,520 Replies
1070 Topics
C
Level 1 ●
Crystal250Level 1 ●
asked in Qualtrics API
Contact Search API in R

Hi all,Referencing api.qualtrics.com/c79e78a949572-search-directory-contacts, I had ChatGPT help me create a script to search my Directory for emails that equal “test@test.ca”. I already know that there are over 12,000 of these.Using the black windows on the page above, I am able to (a) change the pageSize and return fewer records (and different skipTokens) and (b) use the new skipToken to retrieve different records.In my code, if I put the pageSize in the url I can modify the pageSize and return fewer records. If I put the pageSize into the body of the request nothing happens, I always get 100 records. For skipToken, I can never get it to work - I always get the same 100 records and the same skipToken returned. Can anyone help?I know this is code-specific to R :( If you have another way to use the API (secure and free, doesn’t store my API or the data) or to accomplish my task that works too. I am trying to pull a list into Excel so that I can verify with all of our users that I can d

140
C
Level 1 ●
I
Ilse
asked in Qualtrics API
"Various filtering options" response export

Hi,I was going through the documentation on the new response export (https://api.qualtrics.com/guides/docs/Guides/Common%20Tasks/getting-survey-responses-via-the-new-export-apis.md) and saw the following:"You can use various filtering options to this request to retrieve a subset of the responses to speed up processing." Which got me very excited. However, the various filtering options seems to be just one option namely using a filter that was created manually using the UI. Am I overseeing something? I would love to just be able to create/use filters completely using the API without having to add them by hand using the UI. Thank you in advance!

1811
C
H
Harshitha_13
asked in Qualtrics API
Contact Export Statistics and Embedded Data

Problem Statement:Export contact data(Contact Statistics and Embedded data) filtered by statistics and embedded data. How this can be achieved? Proposed solution:https://yul1.qualtrics.com/API/v3/directories/{directoryId}/contacts/search- Can we apply filter in this API on Embedded data and contact statistics fields and can we fetch records more than 10000?https://yul1.qualtrics.com/API/v3/directories/{directoryId}/export-contacts- Can we export contact statistics using this API

924
AlonsoC
Administrator
C
Level 2 ●●
cpschroederLevel 2 ●●
asked in Qualtrics API
Changing usage tags via the API

Hi!We are currently using the survey-tagging function for our reporting. (The dropdown field that appears when you publish a survey or the menu available under [Tools | Survey tagging] in the survey editor.)Unfortunately, we now face the requirement to change a couple of hundred project labels, so my colleague asked whether we could do this using the API. But there seems to be no such field among the usual suspects, i.e., endpoints such as survey definitions or survey options.Do I see this correctly or is it hidden somewhere else? Just want to make sure.

491
E
Level 2 ●●
S
sebkowald
asked in Qualtrics API
Access UsageTags via API

I am trying to read the UsageTags of a survey via an API call. In the official docu I couldn’t find anything to this matter. Does anybody know a workaround how to access the UsageTag of a survey via API?Thanks! 

371
E
Level 2 ●●
P
Level 1 ●
priyakrishnanLevel 1 ●
asked in Qualtrics API
Looking for developer for API integrations - Qualtrics, Google Sheets and Twilio

We are urgently looking for a developer to create an API integration with Qualtrics, Google Sheets and Twilio. Please contact me over phone or WhatsApp if you can help. My number is +351932830898

461
AlonsoC
Administrator
E
Enrico
asked in Qualtrics API
How to extract all ProjectID with API

Hello everyone, I'm looking for a way to bulk extract the project IDs of my EX projects.I would like to know if there is an API similar to https://fra1.qualtrics.com/API/v3/surveys. I have read the documentation but haven't found anything about it.Thanks for the help,Enrico

330
E
M
Level 2 ●●
MaxLovellLevel 2 ●●
asked in Qualtrics API
Aligning API responses for Survey Definition and Export Response endpoints

I have noticed that the survey-definitions/{id}/questions endpoint (https://api.qualtrics.com/5d17de1a27084-example-use-cases-walkthrough#retrieve-an-existing-survey) returns question names that don’t align with the export-responses endpoint (https://api.qualtrics.com/6b00592b9c013-start-response-export). For example, when querying the survey definition, I have a question with QuestionID: QID1, DataExportTag: Email, QuestionType: TE, and then when exporting this response the field is actually called Q1D1_TEXT. At the moment it looks like I will need to detect what the question type is and append the expected type to the question ID myself. Probably _1, _2... for multiple choice, matrix, rank, etc, and _TEXT for text entry. Is there a list of what suffixes I will need to do this, or a better option for finding the export names in advance?If not, surely these should align in some way, and surely there shoud be a field in the survey definition which actually gives you the name or names of

751
M
Level 2 ●●
J
jmcclung
asked in Qualtrics API
Delete users API saying user not found?

Hello, I’m trying to remove users that have accounts in Qualtrics but have either never logged in or haven’t logged in for over a year.  I pulled a list of users from the User Admin section of my dashboard setup.  This showed me their last login date but it did not have their userId. So I used the “List User” function of the API to pull a list of all my users into a CSV file that does have their userId and then did a vlookup against the export from the dashboard above.  So with these two files I was able to make a list of users that I wanted to delete that has their userId. Now I want to use the CSV file with the API to delete the users.  The only column in my CSV file is called userId and the user ID’s are listed beneath.  The problem I’m having is that it’s returning a message saying that the user is not found: {"meta":{"requestId":"72375b15-4e33-4441-aa09-7b66ba723968","httpStatus":"404 - Not Found","error":{"errorCode":"DU_3","errorMessage":"User not found."}}}User details: {'userI

492
J
PeeyushBansal
Level 6 ●●●●●●
PeeyushBansalLevel 6 ●●●●●●
asked in Qualtrics API
Interactive Employee engagement survey

Can someone give example of some interactive employee engagement survey, like what customization we can do to make it appear nice and highly interactive.

191
PeeyushBansal
Level 6 ●●●●●●
P
Level 2 ●●
preichowLevel 2 ●●
asked in Qualtrics API
Chrome Warning that Qualtrics using a deprecated feature: Unload event listeners are deprecated and will be removed.

Hi everyone,Google Chrome is saying that the one of the JS files served by Qualtrics is using an unload event listener that will soon be deprecated.The file:https://siteintercept.qualtrics.com/dxjsmodule/8.29a12639f19bc166d5bc.chunk.js?Q_CLIENTVERSION=2.21.0&Q_CLIENTTYPE=web&Q_BRANDID=The offending line;e.addEventListener ? e.addEventListener(t, n, !1) : e.attachEvent ? e.attachEvent("on" + t, n) : e["on" + this.capFirst(t)] && (e["on" + this.capFirst(t)] = n)) Does anyone know if Qualtrics is going to address this?   I searched for this on Google and only found one results that wasn’t really related.  I can’t believe we’re the only company on this planet with this issue. 

1523
AlonsoC
Administrator
kgillis
Level 6 ●●●●●●
kgillisLevel 6 ●●●●●●
asked in Qualtrics API
Mass close tickets

Is there a way, maybe with an API or something, where I could go in and mass close tickets? My org has thousands of tickets that are active from surveys that took place years ago - nobody is actually going to go and close really old tickets. 

241
nryalls
Level 3 ●●●
V
Vasundhara
asked in Qualtrics API
Translation

I tried changing 'next' and 'practice' buttons to match the language. But Qulatrics is by default applying the translation of the above words to the ENG survey as well. 

161
TomG
Level 8 ●●●●●●●●
B
Level 2 ●●
baharsenerLevel 2 ●●
asked in Qualtrics API
String trucated during download

Hello, I have an embedded data field that has a large text string. The data saves fine, and is correct. When I download my responses though, the string is truncated. How can I prevent this?

223
TomG
Level 8 ●●●●●●●●
I
ian_c_young
asked in Qualtrics API
Automating Qualtrics Survey Creation Using R statistical software

In Qualtrics I have a general survey template that I use to make hundreds of surveys. These surveys are almost identical with the only difference between them being certain words on the surveys vary between surveys (e.g., client name, various brand names, etc.). The questions and structure of the survey remain the same. Currently I have to duplicate a survey and the search and replace brand names, and repeat.I am most familiar coding in R and would love if possible to find a way I can automatically create these surveys in R using a package like httr2.My general thought is load in .qsf file of template into r. Make relevant changes to the qsf file for any number of surveys, and then have those surveys automatically created in my Qualtrics account.Has anyone done something like this and can give guidance on the workflow?

1953
I
J
QPN Level 3 ●●●
jake_dufinetzQPN Level 3 ●●●
asked in Qualtrics API
Brainstorm: Generate Personal Links via API with Transaction Data

We are looking to distribute Qualtrics surveys using our customer facing mobile app’s in-app notification system. The app is expected to push a survey invite link to customers when they reach certain points of the customer journey, in real-time (think for example when a customer scans their ticket into an event venue). The survey invite needs to be tied to the customer and the specific transaction that triggered the invite, which is all stored within the notification system.At a high-level, we see two general ways of doing this:Anonymous link with URL parametersWe can store the base anonymous URL in the push notification template, and then dynamically append the customer’s information + transaction data to the end of the URL so that it gets passed through to the survey response. (ie [AnonymousURL]?[TransactionField1]=[Value]&[TransactionField2]=[Value]...)While this path gets the base job done and is the simplest to implement, it has some cons:The customer could manually manipulate

1892
Q
P
ppuente
asked in Qualtrics API
Create a New Response API and Embedded Data

I want to call the Create a New Response API to create survey responses from my application (https://api.qualtrics.com/f1cad92018d2b-create-a-new-response). I don’t see a way to add embedded data to that request. Is there a way to create add embedded data with a survey response creation request, or am I required to send a subsequent Update Response request (https://api.qualtrics.com/daed82306b1ea-update-response)?

1713
P
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Qualtrics API
Copy participant via web service in survey flow

I would like to add a participant from the directory to a specific project as part of a survey flow, but for some reason I can’t make it work.I have this setup:It should be straight forward, but I struggle to get the body part right. According to the documentation:https://api.qualtrics.com/c03ae4b3e935d-copy-participantsIt should be like this:[  "1234"]I get an “body should be an array type.” error, but the JSON selection should create this.Any help would be much appreciated!

340
JesperAndersen
QPN Level 4 ●●●●
M
MohamedAli
asked in Qualtrics API
Change one of the form field to dropdown

Hi all I need to convert one of the form field (2nd field) to dropdown. I try to search and did not manage and did not understand why the script does not work.below is my Javascript. But it still did not change to the dropdown,  Qualtrics.SurveyEngine.addOnload(function() {    var qid = this.questionId;    // Define the dropdown element and options    var dropdown = `        <select id="QID31-2">            <option value="">Select an option</option>            <option value="tech_data">Tech data (affected)</option>            <option value="non_tech_data">Non-tech data (affected)</option>            <option value="not_affected">Not affected</option>        </select>    `;    // Insert the dropdown after the second field and hide the original input    jQuery(dropdown).insertAfter("#" + qid + " .InputText[name='QID31-2']");    jQuery("#" + qid + " .InputText[name='QID31-2']").hide();    // Ensure that the dropdown element exists

441
C
Level 4 ●●●●
T
Level 2 ●●
treimtLevel 2 ●●
asked in Qualtrics API
List Users API not returning full list of users

When I call the List Users API (https://api.qualtrics.com/c9eeb409d7fe2-list-users) curl --request GET \ --url https://iad1.qualtrics.com/API/v3/users \ --header 'Accept: application/json' \ --header 'X-API-TOKEN:  MYTOKEN ' I get a list of exactly 100 users, which is kind of suspicious (and no error messages ).We have about 190 users.Ideas? Thx!!

451
Nam Nguyen
QPN Level 8 ●●●●●●●●
S
QPN Level 2 ●●
Susana_BrancoQPN Level 2 ●●
asked in Qualtrics API
API that allow me to create a Txt, or CSV file (in order to upload it in sftp)

How can I create an API that allow me to create a Txt, or CSV file (in order to upload it in sftp) with information from results generated in previous task (example distribution link)?

444
S
QPN Level 2 ●●
S
QPN Level 2 ●●
Susana_BrancoQPN Level 2 ●●
asked in Qualtrics API
Generate Custom Distribution Links - error

I’m trying to generate a “Generate Custom Distribution Links”. I start by creating a 1st api to get Distribution ID, and I get a result: EMD_f8QQenNO38ZFEol  {  "message": {    "libraryId": "GR_8q1TNbBxx7Q5TyS",    "messageText": "Example Message Text"  },  "recipients": {    "mailingListId": "CG_2VdLIP44sg4X0qc",    "directoryId": "POOL_DtPeG9ooR50oSA1"  },  "header": {    "fromEmail": "apiexample@qualtrics.com",    "replyToEmail": "apiexample@qualtrics.com",    "fromName": "Test Name",    "subject": "Example Subject"  },  "surveyLink": {    "surveyId": "SV_agUQBVnQcGsoO7I",    "expirationDate": "2025-08-24T14:15:22Z",    "type": "Individual"  },  "embeddedData": {    "level": "sim",    "property2": "string"  },  "sendDate": "2019-08-24T14:15:22Z"} Then I start a second API to get the links, bringing the $.result.id from the previous one. I get these error: {"meta":{"httpStatus":"400 - Bad Request","error":{"errorMessage":"Expected param not found: surveyId","errorCode":"RP_10"},"requ

712
S
QPN Level 2 ●●
S
QPN Level 2 ●●
Susana_BrancoQPN Level 2 ●●
asked in Qualtrics API
API update responses (when a ticket is created) with a standalone workflow - bringing surveyID

There is a way to have a standalone workflow to update responses when a ticket is created (I don’t want to configure several workflows). I can do it easily when I manually input the survey ID.I’m bringing the survey ID as ticket data, and I also tried to create an API to fetch that information, but it doesn’t work. 

14412
S
QPN Level 2 ●●
jcgallont
Level 2 ●●
jcgallontLevel 2 ●●
posted in Qualtrics API
Update responses by API

HelloI am trying to update my responses via API, because after Qualtrics gets the response I need to add some embedded data from my data lake.I saw this API call https://api.qualtrics.com/daed82306b1ea-update-response , but is not clear for me how do I get the response ID in the api call?

13964
S
QPN Level 2 ●●
V
Level 2 ●●
VJTMLevel 2 ●●
asked in Qualtrics API
Modify a drilldown questin using survey API

Hello,The survey API documents how to modify multiple choice, matrix and other types of questions.There is no indication about how to modify a drilldown question.Has anybody used the survey API (or any other) to programmatically modify a drilldown question?This is my use case:we run a continous survey for a customer. This survey has several drildown questions to chose related values. Let’s say cities with a store in a state. We provide to the drilldown the list of states and stores, once the client selects the state, the next drilldown only contains stores in that state.Stores in a state can change maybe monthly due to new ones joining the brand or old ones leaving the brand. Every month we must update the mapping table.I want to do that programmatically connected with my customer’s usiness systems. In order to do that I download the mapping table from their business systems, but I cannot see how to push it to update the drilldown question definition. Thanks in advance,

281
vgayraud
QPN Level 6 ●●●●●●

Motivational Playlist

Terms & Conditions