Qualtrics API | XM Community

Qualtrics API

Discuss API solutions, best practices, and more.

  • 975 Topics
  • 2,292 Replies

975 Topics

R
Level 1 ●
rarcegaLevel 1 ●
asked in Qualtrics API

How to grab a field from opted out contacts in the directory?

Is there a way I can automatically schedule (e.g. daily) a way to extract a specific embedded data field from contacts who opted out and either send this list to an ftp site or email it?  

0
R
Level 1 ●
1 day ago
R
rrosa
asked in Qualtrics API

Submit question response via Survey Sessions API

I'm trying to integrate a Qualtrics survey with my chatbot platform.The Survey Sessions API seems perfect for what I'm doing but the documentation is limited, so my understanding of this API may be incorrect. This is the idea:User triggers a new survey session via the chatbotChatbot calls "new survey session" endpoint, which returns SessionID as well as the first question block which contains a single questionChatbot presents the first question to the userUser chooses a responseChatbot calls "update session" endpoint, sending the chosen response and advancing the session to the next blockChatbot calls "fetch current page" endpoint, which returns the new blockChatbot presents the next questionEtc...Somebody please correct me if my understanding of the API behavior is incorrect, or if there is a better endpoint for this usecase.My question is about returning the user's response in the "update session" step. The API Doc doesn't do a good job of explaining how to map responses to questions

3
C
QPN Level 2 ●●
1 day ago
R
rrosa
asked in Qualtrics API

Clarification on Update Session API endpoint

Hi!I need to use the "Update Session" endpoint in the Take Survey API, but I don't understand how to map responses to questions in the request body. Can anybody provide example usage of this endpoint with submitting a response to a multiple-choice question?Appreciate it!

2
C
QPN Level 2 ●●
1 day 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

7
S
Level 6 ●●●●●●
1 day ago
S
Level 1 ●
sics_sue_chooLevel 1 ●
asked in Qualtrics API

API to extract response in progress?

is it possible to pull data from response in progress via API? 

0
S
Level 1 ●
2 days ago
R
Level 1 ●
rarcegaLevel 1 ●
asked in Qualtrics API

Adding another field to the "List Opted Out Directory Contacts" API call

I was able so successfully ran an API call that listed opted outs from the directory. Aside from name and email, I also need a specific id (CID) in the output in order to link the records to our internal database. This field (CID) is an embedded data field that exists in all of our mailing lists. Is it possible to include this in the output of this API call?

0
R
Level 1 ●
2 days ago
M
mhiser1024
asked in Qualtrics API

Adding Time Delay between API Call retries

When we make API calls from Qualtrics to other services, is there any way to add some time between retries? For example, when the call fails, it will automatically retry, but within a few milliseconds of each other. This generally results in continued failure. It would be great to be able to build in a long delay between automatic retries. Is this possible?

0
M
5 days ago
V
VijayataKeshari
posted in Qualtrics API

Can anybody help me with Qualtrics and Power BI integration?

I would like to extract data from qualtrics to Power Bi directly using API

1
C
QPN Level 2 ●●
5 days 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.

1
R
Level 3 ●●●
8 days ago
W
Level 1 ●
WeissLevel 1 ●
asked in Qualtrics API

API Responses works for shared surveys, but not my own

Hello, I get a very strange API error. When I use the responses endpoint to write responses into a survey, I get the error message “survey not found”. However, it works if I change the surveyID to a survey that is shared with me. So I can write responses in shared surveys, but not my own (same brand platform). Even if I copy the shared survey and use the surveyID of the copy, it is not working.Getting the survey response scheme works for all of my surveys. Any ideas, what’s wrong. Is there some setting in the survey that blocks my request?

1
R
Level 3 ●●●
9 days ago
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 ●●●●●●
11 days 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 ●●●
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 ●
12 days 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 ●●●●
12 days 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 ●●
12 days 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 ●●
15 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 ●
15 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
19 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
_
22 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 ●●●
24 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
29 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
1 month 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
1 month 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
1 month 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 ●●●●●
1 month ago

Productivity playlist

Terms & Conditions