Qualtrics API | XM Community

Qualtrics API

Discuss API solutions, best practices, and more.

  • 981 Topics
  • 2,301 Replies

981 Topics

D
danwbd
asked in Qualtrics API

Getting error "insufficient_scope" in API call

We have set scope "manage:surveys" and "read:surveys" to our Client ID through web interface. After this we generated the Bearer Token from API "https://iad1.qualtrics.com/API/v3/surveys", we are getting below error:       "httpStatus": "403 - Forbidden",       "error": {           "errorMessage": "insufficient_scope",           "errorCode": "AUTH_13.0"       }We are getting the same error for all API calls related to surveys.

8
P
11 months ago
N
ngsankar
asked in Qualtrics API

What is the API URL to retrieve all the survey responses

I am unable to find the correct URL to retrieve all the survey responses in JSON format, can someone help me with this? Thanks in advance.

8
N
3 years ago
I
Ingrid_M
asked in Qualtrics API

Archiving and purging XM directory

We send surveys at different stages across the user journey. The data is completely refreshed on a weekly basis. ie if the respondent has moved to the next stage we will use revised embedded data. I want to run a purge and refresh routine to wipe the directory apart from retained emails to manage the contact frequencies (currently one month) - can this be done? ideally automated

8
bgooldfed
Level 4 ●●●●
12 days ago
D
DharmilRathod
asked in Qualtrics API

How can we send email notifications for "In-progress" survey responses?

Hi Everyone, I have a unique ask… So I am building a B2B research survey which is super long and it could have up to 80 questions. The respondents could take up a few days/weeks to complete the survey. My question is..there are few questions within the survey that I need to flag right away and send email notifications. Lets say for Q28, if anyone who selects “Yes”, I send out an email notification to my team member. The only concern I have is that the survey is still in progress and not completed so I can not even create a email notification workflow.Is there a way where I can send email notification even when the survey is still in progress?Looking forward to your out-of-the-box solution on this. Thanks!

8
K
Level 1 ●
26 days ago
R
rscharer
posted in Qualtrics API

Best practices for sending distributions to individuals

Hi all —From what I can tell, generating survey links for individual contacts isn't supported (yet) — the target needs to be a list. Our use case is going to require on-demand surveys. I can easily see us just creating mailing lists containing a single contact each time we need to generate a link, but before we go down that road I'd like to know if we're going to hit some kind of upper limit on the number of mailing lists. We could easily hit 10-20k+ within a year. I could also see us creating lists on demand, generating the link, and then deleting the contact list, though I don't know if that would effectively break the link. A third approach would be to garbage collect old lists once the survey results come back.Please let us know how you'd recommend we implement this.Thanks,Ryan

8
R
1 year ago
M
monikaschwartz
asked in Qualtrics API

Error using export-responses API

Hi all,I am new to Qualtrics API. I have been able to get myself past obstacles with getting my bearer token for the right scope etc., but this one has me stumped. I am getting the response "Json type body is expected" but the body looks ok to me. I got a successful response using the form on the API documentation and even tried copying the simple body from there and I still get the error. My content type is JSON and Postman obviously thinks it's valid because it's color-coding it properly. If the picture doesn't come through, all I have in the body is:{    "format": "csv"} What am I missing?thank you!

8
P
11 months ago
A
Level 2 ●●
altatuncLevel 2 ●●
asked in Qualtrics API

Querying if Person already took a survey

Lets say I have a an Embedded data point that stores a person’s ID when they take a survey.  What would be a good way to query response data to see if a person has already taken the survey? Essentially, I need to check all current results to see if that Person’s ID is already there and if so, return a message to the end user. Thanks! 

7
A
Level 2 ●●
2 days ago
Y
yinbar
asked in Qualtrics API

Using Qualtrics API to get the value of embedded data of specific respondent

I have a Qualtrics survey link called from a different platform (MTurk). Each respondent will enter the survey only through this site. After each completion, I'd like to get an embedded data that was randomly set by Qualtrics (this is actually the random assignment of respondents, so should be a randomly selected one value, out of two values). Is there a way to do this for each specific respondent? It's important to note that there might be multiple participants taking the survey at the same time.Thanks!

7
TomG
Level 8 ●●●●●●●●
2 years ago
J
John_E
asked in Qualtrics API

How can I import some of the data from a survey into a SQL database.

We are currently using .net and C# to read/write to this database but I don't see any options for that in the API documentation. The users would like these updates to happen real time but that may not be an option.

7
SamS
Qualtrics Employee
5 years ago
C
CodeCollective
asked in Qualtrics API

I want to direct every new participant to a unique/different block. Is this possible?

Hello experts,I want to run an experiment in which I need to direct every single participant to a different external website. Therefore, I would like to show participant #1 Link #1, participant #2 Link #2 and so on.  Is there a way to count how many participants have started the survey? I read that it could be possible to set up a quota and count how many participants have already finished the survey. However, if participant #1 and #2 start at the same time, then they'd both unfortunately see Link #1. I also thought about just creating one condition for every possible participant. Let's say I predict 100 participants will participate, that'd mean 100 conditions, so 100 unique blocks. However, I could just randomize them into the conditions, meaning that two participants might end up in the same condition. Or is there a way to direct participants to a block and then prevent any other participant to ever be directed to that block again?

7
C
3 years ago
pogi
Level 2 ●●
pogiLevel 2 ●●
asked in Qualtrics API

Graphics Library

Is there a way to capture the file URL from a file upload question and use it to upload the image directly to a specific graphics library folder?

7
TomG
Level 8 ●●●●●●●●
3 years ago
R
ralbritton
asked in Qualtrics API

Updating Reponse - ERROR G_2

I'm trying to update a resonse using the API but I'm getting an error { "meta": { "httpStatus": "500 - Internal Server Error", "error": { "errorMessage": "Internal server error. Please contact Qualtrics support.", "errorCode": "G_2", "instanceId": null }, "requestId": "93a2aa39-ac8c-4a17-9e2a-d6058d56112e" } } PUT REQUEST: url: https://utahgov.co1.qualtrics.com/API/v3/responses/R_etcxaC3q9p7WCXj headers: {content-type: application/json, x-api-key: MYAPIKEYHERE} Request Body: { "surveyId":MYSURVEYIDHERE "embeddedData": {"Status of Application":"Pending"} } The above is from testing with PostMan. I've also tried in python with the same results. Thank you

7
L
4 months ago
mklubeck
Level 3 ●●●
mklubeckLevel 3 ●●●
asked in Qualtrics API

How can I use the API to copy data from my Contact List (Trigger) to a Google Sheet?

I'd like to make the data from my Contact List Trigger (using to collect data throughout a workflow) and I'd like to copy the contact list (all fields and data in them) to a Google Sheet so I can then "share" with others. Any ideas? I'm guessing I need an API Call.

7
AravindA
Qualtrics Employee
6 years ago
E
ExeCTU
asked in Qualtrics API

How can we generate a personal link for an individual contact within a mailbox?

Hi We are using Qualtrics to present a questionnaire to participants in a mental health study that we are running. Our survey participants arrive first at our website where they are screened. For those who are eligible, we then: i) make a call to the Qualtrics API (API/v3/mailinglists/<mailing_list_id>/contacts) to create a contact in the study mailing list ii) make another call to the Qualtrics API to create a distribution list (API/v3/distributions) which returns the distribution id ii) use the distribution id to get the survey link (API/v3/distributions/<distribution_id>/links?surveyId=<survey_id>). The issue we have is that each time we create a distribution list a link is generated for _all _the contacts in the mailing list. Using the Qualtrics user interface it is possible to create a distribution list for a particular survey participant, but this does not seem to be an option via the API. The only workaround I can see is that we create a separate mailing list f

7
J
2 years ago
R
RCBIZMarketing
asked in Qualtrics API

How to use the Qualtrics API in conjunction with Power BI?

I've been doing research for a long time now and I see no clear way on how to connect Power BI and Qualtrics through the Qualtrics API. What I'm aiming to do is automate the process of importing survey results into Power BI. Currently I just have a spreadsheet that I manually add new survey results to as they come in. I got instructions on how to do it with the 2.5 version which seemed easy, but I've been advised to stay away from that now and do it the v3 way. The v3 way makes 0 sense to me and seems not possible to directly connect to Power BI.

7
R
1 year ago
H
Level 2 ●●
happychuck77Level 2 ●●
asked in Qualtrics API

Dynamic Drop-Down List

I am building an always-on survey to be posted on my company’s intranet in which employees can rate any office, department, or team they wish through these questions:Please select the office from the dropdown menu. Please select the department from the dropdown menu. Please select the team from the dropdown menu.Because offices, departments, and teams frequently change, I don't want to have the selections be a static drop-down list.Instead, I would like the drop-down menus for these three questions to dynamically pull in options from the Location, Parent, and Team field (respectively) that are part of the embedded data from our Workday automation. Is this possible? 

7
H
Level 2 ●●
2 months ago
C
Level 2 ●●
cgillonLevel 2 ●●
asked in Qualtrics API

Assigning randomly selected options to embedded data

Hello,I have a situation where respondents can select multiple responses to Q1 (a list that could have up to 100 possible options). I then want to narrow the selected list down to 5 random options and assign these 5 responses to some embedded variables, for later use. So that I can make sure these random 5 options are evenly distributed amongst the total sample, I’m utalising the 'Advanced Ramodization' feature to select my 5, but I’m not sure how to then extract the 5 selected options into the relevant embedded variables.My current thinking was to use the following script, but it isn’t working…Qualtrics.SurveyEngine.addOnload(function() { // Retrieve selected options from the advanced randomization var selectedOptions = this.getSelectedChoices(); // Store the selected options in embedded data elements for (var i = 0; i < selectedOptions.length; i++) { var embeddedDataName = 'SelectedOption_' + (i + 1); // Name for embedded data element (e.g., SelectedOption_1, Se

7
C
Level 2 ●●
1 month ago
B
Ben_Khosro1
asked in Qualtrics API

API to upload a CSV email list

Hello All: I am a newbie and am in the need of the uploading my contact list via API (C#). Where can I find a sample API code for this? Thank you;

7
A
5 years ago
C
coe_ds
asked in Qualtrics API

Clarification on "Active" Surveys

Hi there, I was wondering if there is clarification for what it means for a survey to be active? I’m trying to create a script to pull data for all surveys that are closed down and no longer collecting data. Is this equivalent to isActive == False? I only want to pull the data for surveys that are no longer collecting responses. Thanks!

7
Nam Nguyen
QPN Level 7 ●●●●●●●
6 months 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

7
KendraR
Qualtrics Employee
4 years ago
K
QPN Level 1 ●
Kennedy_IQPN Level 1 ●
posted in Qualtrics API

Generate Individual Link via API

Is there a way that we can generate survey link for a single contact? I know there's an API under Create Distribution but this will create links for all contacts in the mailinglist. My use case is for Live Chat post-transaction, so I need to generate an individual link everytime customer completed their transaction with a live agent.

7
_
1 month ago
R
Ray_Weiss
asked in Qualtrics API

Can someone please explain this error (and its' remedy) to me?

Hello Qualtrics Community, I am attempting to use Qualtrics to distribute a survey, using the API. All the requests I have tested have worked fine, so far, except when I attempt to distribute the survey. Then, I get this error, saying "You do not have permission to access distributions for this survey." My belief is that the account I am working on has permissions limited, and there is a control panel in the "master admin" account for the license I am working under. Is this correct? Any help is greatly appreciated. !

7
R
4 years ago
E
EmilyG
asked in Qualtrics API

Get Response Export via API

Hi, I've been pulling out survey responses using Qualtrics's API function. However, I seem to be getting the responses as numeric values instead of choice text and this creates a difficult in automating this process. I've tried using the useLabel = false in the API call but it still seems to default to the numeric values. Are there any thing other parameters that I should put in place to get the responses as choice text? I'm currently using both Legacy Create Response Export and Legacy Get Response Export File. The new Get Response Export function doesn't seem to work at my end. I'm really struggling with this and hope someone could assist.

6
N
3 years ago
A
apisoni
asked in Qualtrics API

Limit access to API

Hi All, We have a use case where we want some users to be able to access the APIs to pull survey responses, but we do not want them to be able to delete anything. Is this feasible? Thanks!

6
A
5 years ago
M
MarkCVL
posted in Qualtrics API

Qualtrics API Stability

Hi folks, Has anyone had generally inconsistant behaviour when using the Qualtrics APIs? Im running an app that runs 5 extracts, 2 of them via https://api.qualtrics.com/docs/get-directory-mailinglist and the other 3 via https://api.qualtrics.com/docs/create-response-export-new. All 5 of them run, inconsistantly as below, so Im pretty sure structurally everything is fine. However, every so often I get an 500 - Internal Server Error, for no obvious reason and with no relevant error information returned so I have to assume the problem is on the Qualtrics api side. I have retry functionality built into the app, sometimes after a 500 error, the next attempt retry will work without a problem, other times I will get a repeated 500 error and then a successful run, other times 500 error will repeat constantly. Anyone else hit this issue? Cheers, Mark

6
J
2 years ago

Productivity playlist

Terms & Conditions