Qualtrics API | XM Community

Qualtrics API

Discuss API solutions, best practices, and more.

  • 970 Topics
  • 2,284 Replies

970 Topics

K
Level 1 ●
kgittnerLevel 1 ●
asked in Qualtrics API

Sending email during in-progress survey using embedded data in survey workflow

I have found 3 posts, tag below, looking for a very similar request, but none of them include details of how to execute this. As a participant starts a survey, I will ask them to enter their email address. After this block is completed, I want to use workflow to send an email to the participants embedded email address they entered. I attempted to first use the “additional response types” and selected the “included incomplete response” suggested in method 1 below. Unfortunately, I only get the email once the survey is completed.Goal: once the participant enters their email and submits that information. I want to send an automated email to that embedded email address, that includes 1 piece of additional embedded data from earlier in the survey to be included in the email body. I do not want this email to wait until the survey is completed, I want the email to send immediately after submitting their email. I don’t care how I have to execute this, I’m just a novice when it comes to API req

3
A
Level 6 ●●●●●●
14 hours ago
B
BenoitO
asked in Qualtrics API

Retrieving Distribution without survey (created at directory level)

Hello,I am not able to figure out how to get a distribution created through the directory without a survey.It’s basically used as an announcement to our target panel.The API “List Distributions” (API Reference) take a mandatory SurveyID.

0
B
15 hours ago
S
sahar_abdelnabi
posted in Qualtrics API

Graphic API upload to a certain library folder

Hi, I am trying to use the graphic API to upload images (it is a large number so it is easier to use the API rather than upload them via the browser).I managed to upload them but I want to divide them into folders, which does not seem to work. Here is my code:headers = {"x-api-token": apiToken }files = {'file' : (path, open(path, 'rb'), 'image/jpeg'),"folder": graphic_folder}baseUrl = "

3
ashleigh_quaill
Level 3 ●●●
1 day 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 ●
1 day ago
A
am-jo
asked in Qualtrics API

Getting survey data from Qualtrics API using R

I am trying to download survey data (around 5000 responses) from Qualtrics using the API in R. I am using the `qualtRics` package. Here’s my code: library("qualtRics")qualtrics_api_credentials(api_key = "abcxyz", #A valid token key base_url = "dc1.qualtrics.com", install = TRUE)surveys <- all_surveys()glimpse(surveys) #this gives me a list of surveys from my qualtrics account. ema_survey <- fetch_survey(surveyID = surveys$id[6])glimpse(ema_survey)> ema_survey <- fetch_survey(surveyID = surveys$id[6], verbose = TRUE) |=======================================================================================================| 100%── Column specification ─────────────────────────────────────────────────────────────────────────────────────────cols( StartDate = col_character(), EndDate = col_character(), Status = col_character(), IPAddress = col_character(), Progress = col_character(), `Duration (in seconds)` = col_character(

2
EricCrayon101
Level 4 ●●●●
1 day ago
I
IshanSharma
asked in Qualtrics API

How to update contact fields in survey response using update response API?

Hi,I am using update response API (https://ca1.qualtrics.com/API/v3/responses/{responseId}) to update the embedded data in my survey responses. But I am unable to update the contact fields like recipienceEmail, recipientFirstName, recipientLastName using the same API. I understand that these fields are not part of embedded data but the api call is not returning any error. I am receiving below message, but the changes are not being reflected on the portal.{"meta":{"httpStatus":"200 - OK","requestId":"ee5f31da-aacd-4e98-86b0-40ffec545f88"}}Below is the structure of my requestpayload = {        "surveyId": surveyID,        "resetRecordedDate": False,        "embeddedData": {                "recipientEmail": "donotdisclose@email.com",                "recipientFirstName": "FirstName",                "recipientLastName":"LastName",  }}Please support

4
D
Level 2 ●●
1 day ago
E
eborisow
asked in Qualtrics API

How can I narrow response counts to a particular date?

Hi,New API user. I wanted to create an automated process to output the number of response counts of users/divisions for a fixed period (e.g. last month). When I access the response counts on a division, it only returns the response counts for all time. Is there any way to filter the results and return only those within a certain date range?Thanks!

1
VirginiaUKY
Level 2 ●●
4 days ago
W
Level 1 ●
WeissLevel 1 ●
asked in Qualtrics API

invalid user in api call

Hello, I receive an error while calling the api via the webservice in a survey workflow and also by using an external python script: {"errorMessage":"invalid_client","errorCode":"AUTH_6.0"}I have set the api token as authentication. Any idea what causes the error? Is it possible that I can create an api token, but have no permission to use it?This is the python script (not incl. my ids and token): import requestsdef copy_survey(api_token, data_center, owner_id, template_id):    # Construct the URL    url = f'https://{data_center}.qualtrics.com/API/v3/survey-definitions'        # Headers for the request    headers = {        'Authorization': f'Bearer {api_token}',        'Content-Type': 'application/json'    }        # Data (payload) of the POST request    data = {        "SurveyName": "Copied Survey",        "SurveyDescription": "This is a survey copied from a template.",        "ProjectCategory": "Academic",        "SurveyOwnerID": owner_id,        "SurveyTemplateID": template_id    }

3
W
Level 1 ●
4 days ago
U
UR_397SxW0nSu4J6Ki
asked in Qualtrics API

Get Survey data only for surveys that changed.

Do I have an option to call all https://xxx1.qualtrics.com/API/v3/surveys/ , but only the ones that has any update.  Do we have a filter here on lastModified?  I didn’t see documentation for that. The same question is about this API: https://api.qualtrics.com/{SurveyId}-retrieve-survey-json-schema Do I have a way to know that the schema has changed.The same for https://xxx.qualtrics.com/API/v3/surveys/ I don’t want to read it every day, only if a change has accrue.Thanks,Lihi 

0
U
8 days 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
_
11 days ago
A
AndyMc
asked in Qualtrics API

Query the individual results of a survey via REST API

I'm trying to understand how to query the individual results of a survey. - I configure an Event Subscription for "surveyengine.completedResponse.{SurveyID}". - Qualtrics sends a push notification to my server with the ResponseID and SurveyID each time {SurveyID} receives a response. How do I then get the data associated with that response? From reading the documentation making a request to https://yourdatacenterid.qualtrics.com/API/v3/responseexports will give me ALL responses - I just want the single response.

21
T
Level 3 ●●●
13 days ago
S
ShenR
asked in Qualtrics API

Can you filter elements result in API for List distribution links?

I would like to ask how we can put filter in the API call. For the example of the screenshot below, I only wanted to se results under linkExpiration: 2021-09-13T20:32:00Z. The purpose is I only want to generate links of just the newly added contacts to save my time in manually removing unnecessary entries.

1
W
18 days ago
C
Level 2 ●●
ccosartLevel 2 ●●
asked in Qualtrics API

API calls getting 404 for anyone else? 'Get Mailing List Contact' in particular

As of just an hour or two ago, we are getting a 404 error on the “Get Contact in Mailing List” call: https://iad1.qualtrics.com/API/v3/directories/{directoryId}/mailinglists/{mailingListId}/contacts/{contactId} Unfortunately this is at the beginning of the survey and breaks the whole thing. Nothing on our end has changed, we’ve used this hundreds of thousands of times over the years….

12
D
19 days ago
J
jeffbhughes
asked in Qualtrics API

Search Directory Contacts api question about filters

For the Search Directory Contacts api https://api.qualtrics.com/c79e78a949572-search-directory-contacts Is it possible to filter based on the value of an embedded data field?   The documentation above doesn’t appear to cover this(qualtrics newbie here), but I’m attempting to help someone replace an older api request that was doing this.   Example:   if I have an embedded field, XYZ, I want to filter on XYZ=’ABC”. Thanks for your help.

0
J
21 days ago
R
ranjith.gonugunta
asked in Qualtrics API

Error when trying to export a TextIQ fields using API; grouped the fields within embeddedIds in the request payload

Hi,I am trying to use survey export API to export few TextIQ generated fields and when trying to export selected fields. If not for embeddedDataIds, which would these fields need to be listed.I have added the field under the `embeddedDataIds` in the request payload. like  “embeddedDataIds”:[ "Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy1",    "Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy2",    "Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy3",    "Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy4"]Request Response:{    "meta": {        "requestId": "dfb01165-86a7-4e14-b050-c3f005346e52",        "httpStatus": "400 - Bad Request",        "error": {            "errorCode": "RTE_2",            "errorMessage": "The following invalid columns were requested: [Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy1, Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy2, Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy3, Combin_DERIVE_8e13ed10_5slhnnxucs5zTopicHierarchy4]"        }    }}

0
R
26 days ago
M
Michele22
asked in Qualtrics API

Qualtrics-IDs

For our survey, we need to know the qualtrics-image-ids of png-files we uploaded to the qualtrics library. up to now, i could follow this tutorial Finding Qualtrics IDs. But with the latest qualtrics release there is no ‘qualtrics id’ tab in the account settings anymore. where can i find the image ids now? Thanks for your answer!  

3
Sachin Nandikol
QPN Level 5 ●●●●●
26 days ago
A
alternapop
asked in Qualtrics API

Filter - "recorded date" includes what?

Under the Data & Analysis tab, we created a filter for “Recorded Date” equals “last 7 days”. When I call this filter, using the Qualtrics API, is “last 7 days” equal to 168 hours (24/7) back from the moment it’s run? Or is it today’s responses, so far regardless of the time ran, plus the previous 6 days? (or something else?) Thank you

3
Deepak
QPN Level 8 ●●●●●●●●
27 days 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 ●●
29 days ago
A
Adam Beattie
asked in Qualtrics API

Create contact in mailing list failing in Microsoft Flow - Issue with parameter: directoryId

Hey Team,First time poster here.I have been getting an error while trying to run a MS Flow using HTTP - Post to upload sample data to survey.I can get it to work within postman so the credential side of things seems to be working. I’m the admin / end user of the platform as well so there should be no access limitations from my understanding as I have another flow running that saves the survey response data as a CSV. The query I’m running is:The body of the error is below: {  "meta": {    "httpStatus": "400 - Bad Request",    "error": {      "errorMessage": "Issue with parameter: directoryId, please fix and try again. Reason: Invalid TA directoryId.",      "errorCode": "TA_IPL"    },    "requestId": "74a2b5ae-****-****-****-***d83515b11"  }} I’m wondering if potentially I’m missing anything else in the headers or query to run this call?I have also tried the ID’s outside of the variables, screenshot is showing them in the variables for privacy reason.

2
A
30 days ago
C
Level 2 ●●
cpschroederLevel 2 ●●
asked in Qualtrics API

Creating survey from library template not possible using the API?

Hi everyone,I just wanted to make sure that this is correct:It isn’t possible to use the API to grab a survey template from a library and make a survey project out of it---or is it?I have scanned the documentation for the respective endpoints (library, survey definitions, survey CRUD) and I have tried a few things with the API itself, but couldn’t make it work. Did I overlook something?

0
C
Level 2 ●●
1 month ago
J
James M
asked in Qualtrics API

List Distribution History API call missing contacts?

We’re trying to generate a report that lists the statuses of contacts. We’re using two API calls to accomplish this.List Distribution Links to get a list of everyone that received an email. List Distribution History to get their statuses.The problem is that for some distributions (not all) the 2nd call will return less contacts than the 1st call. Some of the contacts are missing. Shouldn’t the same number of contacts be returned by both if we’re using the same distribution ID?

3
J
1 month 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 ●●
1 month ago
C
Level 2 ●●
cgillonLevel 2 ●●
asked in Qualtrics API

Extrapolating a slider question into a list of all combinations

Hello, I have a rather elaborate and specific issue that I am trying to resolve, and would appreciate any guidance that I can get on how I could implement this task (or if it’s even possible). The situation is that I have a survey in which I want to ask respondents how many of a range of products they have bought, then later ask them a series of questions on a limited number of those items.For example,  I have a slider question, at which I ask people how many of each of 4 possible products they have bought. The scale goes from 0 to 10, so there could be a maximum of 40 total products bought.Later in the survey, there will then be a looped block, where I want to ask about a maximum of 5 of the possible 40 products (to limit the length of the survey). i.e. the block will ask where they bough each item, how much it cost, etc.In order to go from the item slider question to the block loop, I need to extrapolate out the slider into the total number of items they have bought…e.g. say they had

0
C
Level 2 ●●
1 month ago
C
Level 2 ●●
cgillonLevel 2 ●●
asked in Qualtrics API

Referencing a previous question within a ‘Loop & Merge’ block

Hello,I was hoping that I could get some help modifying some JS, so that it can work within a ‘Loop & Merge’ block.The script below works for a standard question, where the response from QID1 is used to determine which options will be hidden.I am now wanting to embed these two questions within a looped block (i.e. using ‘Loop & Merge’), but have run into the problem where the initial reference to the selection from QID1 is no longer working, as there is now a loop count being applied to the question ID. Accordingly, I need to find a way to append the loop number to the reference of QID1, so that this code always applies to the question that directly preceded it (i.e. the one that is in the same loop). Qualtrics.SurveyEngine.addOnload(function() {var x = "${q://QID1/ChoiceGroup/SelectedChoices}";if (x === "Brand1") {jQuery("#" + this.questionId + "input[choiceid='3']").closest("li").hide();} else if (x === "Brand2") {jQuery("#" + this.questionId + "input[choiceid='6']").closest(

4
C
Level 2 ●●
1 month ago
B
Level 2 ●●
brianjLevel 2 ●●
asked in Qualtrics API

API Endpoint to Return Survey Name and Owner ID of Other Users in Brand

Do any API endpoints currently exist that would allow me (as the brand administrator) to look up the Survey Name and Survey Owner using a Survey ID for projects owned by another user in my brand?From my read of the documentation and limited testing the GetSurvey and ListSurveys endpoints appear to only work for surveys that are owned by the person making the API call.It is nice that the User Search page within the Admin console allows one to search by Survey ID and return the user who owns the project, but it can still be difficult to pinpoint which specific survey a Survey ID refers to when the user has many projects. 

0
B
Level 2 ●●
1 month ago

Productivity playlist

Terms & Conditions