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
L
LukaszK
asked in Qualtrics API
How to refresh the OAuth token?

Hi! I'm following this guide on implementing OAuth2: https://api.qualtrics.com/instructions/docs/Instructions/Quick%20Start/getting-more-secure-with-oauth.md Everything is fine so far, but the docs do not mention how to refresh the token after expiry - what is the endpoint to call and what are the parameters? Usually I'd expect a call to oauth/token?refresh_token=...&grant_type=refresh but it's not mentioned anywhere.

9523
J
QPN Level 3 ●●●
J
Level 1 ●
jasonfernsLevel 1 ●
asked in Qualtrics API
Need help with Import Response API

I have exported my survey responses as a CSV file because I wanted to update few responses that is why I also exported the response ID’s . Now I made the updates to the responses in the CSV file in excel and I want to import them using API (there are more than 1 Lakh responses).The CSV file is present in my downloads folder. I want to use import API to import the responses, I went through the support docs but still cannot understand how to use it.We can do it either using python or postman. Can anyone please provIde me the python script required to import the responses? If not the python code I would appreciate some detailed step by step guidance as to how to do it in postman. 

1084
J
Level 2 ●●
chackbusch
QPN Level 5 ●●●●●
chackbuschQPN Level 5 ●●●●●
asked in Qualtrics API
Export Survey Response as PDF via API

We have some requirement to export a survey response with all answers given from an external system. I see that there is some solution for that on the UI (Data & Analysis - Actions - Export to PDF): However, we need to export responses from an external system and thus need some corresponding API. I had a look on the API reference and found the "Surveys Response Import/Export API". Unfortunately, I think this does not help in our case since PDF is not available. Does anyone know if there is a API available for the "Export to PDF" functionality? Another option I was thinking about is to have some (public) available link per response which opens the survey with the responses in the browser. But I guess such a functionality is not available as well since the PDF is generated "on the fly" based on the response data... Thanks for the assistance.

6898
AlonsoC
Administrator
J
QPN Level 3 ●●●
jake_dufinetzQPN Level 3 ●●●
asked in Qualtrics API
OAuth 2.0 Authentication - Workday Outbound File

I am looking to use Workday’s out-of-the-box functionality to send outbound files to external systems (Qualtrics), known as Outbound EIB. I’ve inserted a screenshot of the documentation below. This allows for authentication via OAuth 2.0, which Qualtrics also supports OAuth 2.0. The configuration within Workday requires the following fields:Access Token Generated by making a POST call to the Refresh Token URL, which returned an Access Token Access Token expires after 1 hour Refresh Token I do not know how to get a Refresh Token Refresh Token URL Entered the Qualtrics Bearer Token URL: https://iad1.qualtrics.com/oauth2/token Client ID Generated a new Client ID Client Secret Generated a new Client ID  So far what I have done is go to the OAuth Client Manager in Qualtrics and generated a new client with a grant type of “Client Credentials”. This returned the Client ID and Client Secret, which along with the Bearer Token URL allowed me to generate an Access Token. However, I don’t kno

40
J
QPN Level 3 ●●●
H
hhjones
asked in Qualtrics API
Response Summary PDF by API?

Is it possible to retrieve a response summary PDF via the API? Ideally I'd like to be able to export the responses to CSV/Excel, parse each response for its response ID, and then download the summary PDF for each response using an API call. I found https://api.qualtrics.com/api-reference/b3A6NjEwNjg-retrieve-a-survey-response but it doesn't look like what I need.

1515
arunxmarchitect
T
Level 3 ●●●
thinwybkLevel 3 ●●●
asked in Qualtrics API
How can I get EmbeddedData in

In a QX survey we’ve set EmbeddedData to hardcoded value via the Survey Flow UI interface. In the HTML header we’ve included some JavaScript code and in questions we’ve included JavaScript code for trying to getting EmbeddedData into JS code business logic. We debug the JS code in the QX survey preview mode.The challenge we are facing is that, no matter what QX API/SDK suggestions we found in the docs/community so far we tried, we cannot access EmbeddedData from within JS code:const seenQTagsED = Qualtrics.SurveyEngine.getEmbeddedData('seenQuestions');const seenQTagsED = Qualtrics.SurveyEngine.getJSEmbeddedData('seenQuestions');const seenQTagsED = "${e://Field/seenQuestions}";The JavaScript Question API https://api.qualtrics.com/82bd4d5c331f1-qualtrics-java-script-question-api-class was not helpful at all to get our integration further so far (Contains deprecated API methods, lacks signature docs, ...).

153510
w.patrick.gale
Level 3 ●●●
C
CarlaRochaIzoPortugal
asked in Qualtrics API
Bring Contacts based in an Object from HubSpot to Qualtrics

HiI’m needing some help with either API or a way to change the pipped text code. Use case:I’m getting information from HubSpot. I’m not able to use the Hubspot task in the workflow as it is not a list of contacts that I can bring, but data based in an Hubspot Object. As a solution, the Hubspot team suggested to use the following API: https://api.hubapi.com/crm/v3/objects/p143360983_medis_appointment?limit=100&properties=appointmentid,appointmenttype,appointmentstatus,eventcode,clientnif,clientcontacttlm,clientemail,professionallicensenumber,providernif,hs_pipeline,hs_pipeline_stage,date_concluida,first_name This the API is returning the info needed for my “list” of contacts - contact info and all the properties I need to create a list in Qualtrics. The issue: as the API is returning the different “contacts” divided in $.results[0]; $.results[1]; $.results[2]; etc. I’m not able to use the task Update XM Directory contacts because in the Pipped Text I need to choose for each XM Direc

70
C
J
QPN Level 3 ●●●
jake_dufinetzQPN Level 3 ●●●
asked in Qualtrics API
OAuth 2.0 Client Credentials - Getting Tokens

I am looking to test an integration with Workday that relies on OAuth 2.0 authentication. I am currently trying to test this and by getting a set of access and refresh tokens. Can someone describe how I would get those tokens in a Qualtrics web service task? My setup keeps failing.I’m looking to confirm exactly what would be in the following fields (and in what format):Request URL Headers (with what is the key and value format for configuration in this web service task) Body Thanks!

100
J
QPN Level 3 ●●●
J
JordanDrieamNL
asked in Qualtrics API
Eventsubscription surveyengine.completedResponse.{SurveyID} returning Status = 'Full'

On Tuesday, 9th September, we discovered that the Webhook / Event Subscription surveyengine.completedResponse.{SurveyID} stopped sending Status = ’Complete’ to our endpoint, which caused the related part of our application from working roughly ~70-80% of the time. About the Status parameter, the document claims this: The status will always be Complete if successful https://api.qualtrics.com/66b2ec694d5c2-webhooks Instead, the POST call to our endpoint receives Status = ’Full’ most of the time. There is no mention of a change in behaviour in any documentation that we can find, nor is there any reference of a string ‘Full’ in any of the documentation that we can find. Is this a recent change, or a bug?If it is a change:What exactly does the Status = ’Full’ mean? When will that be sent instead of ’Complete’? Are there other Statuses that could also be sent, and under which circumstances? We can replicate this simply by taking a survey. Most of the time, it will send Status = ’Full’, but

191
J
D
Level 1 ●
dp-gotoLevel 1 ●
asked in Qualtrics API
react-native-qualtrics 2.7.0 issue "no visible @interface for selector 'setLastDisplayTimeForInterceptFor:'

I tried to integrate rn-qualtrics 2.7.0 but iOS compilation get me the error below/node_modules/react-native-qualtrics/ios/RNQualtricsDigital.m:277:34: error: no visible @interface for 'QualtricsProperties' declares the selector 'setLastDisplayTimeForInterceptFor:'I have no clue why I’m getting this. Some hints will be appreciated. Thanks!

1744
D
Level 1 ●
C
Connect
posted in Qualtrics API
Feature Request: Increase Embedded Data Limit for Create Distribution API

Problem StatementThe current Create Distribution API endpoint (https://api.qualtrics.com/573e3f0a94888-create-distribution) has a hard limit of 10 embedded data fields, which creates significant limitations for organizations managing complex survey workflows through API integration.Current Limitation vs. Expected BehaviorCurrent State:API Distribution Creation: Maximum 10 embedded data fields XM Directory Task: Unlimited embedded data fieldsExpected State:Consistent embedded data capabilities between API and XM Directory task  Higher limit / no limit that accommodates real-world use casesBusiness ImpactThis limitation significantly impacts organizations that:Conduct comprehensive interviews/surveys requiring extensive participant metadata Use automated survey distribution workflows via API Need to maintain data consistency between survey responses and participant profilesSpecific Use Case: Our organization regularly conducts interviews requiring approximately 60 embedded data fields pe

596
AlonsoC
Administrator
R
Level 4 ●●●●
Rod_PestellLevel 4 ●●●●
asked in Qualtrics API
Edit / redact sensitive info from an incoming email of a ticket

Hi All, We’ve received some incoming emails through a ticket that show up in the email history section.  Some parts need to be redacted or changed (or failing that the message removed from the email history thread) of the ticket.  Tickets I’m aware can be accessed to some degree via API but has anyone managed to work out if it’s possible (and how) to remove or redact part of a reply? The message contains sensitive information which needs to be removed and so rather than delete the whole ticket (which will cause issues with the guest being unable to reply to the same ticket thread), it would be good to know of an alternative way. Hope someone can advise or if anyone has already raised a product idea (I’ll then vote it up). Thanks Rod Pestell 

120
R
Level 4 ●●●●
L
Level 3 ●●●
Linda_charltonLevel 3 ●●●
asked in Qualtrics API
First try at API updating quotas after some return the item that they checked in

We have the quota set to one so no one can see the item in the survey while it is checked out so we need to get the quota back to 0 when the item comes back in.I get lost where they say that something needs to be object.  I don’t understand what they want for logic or ActionInfo, ActionLogic, or the QuotaStart, QuotaPeriodLength, QuotaNumPeriods, QuotaCountsHere is what I have so far…. 

362
L
Level 3 ●●●
D
DMoon
asked in Qualtrics API
Is there a way to automatically send a bounced survey request via email to a specific person

When a survey does not complete due to a bad email address, we would like to send a email back to a manager to review and get the address corrected. Has anyone gotten this to be done automatically?

682
N
Level 1 ●
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.

3768
S
G
Level 1 ●
Glovecm16Level 1 ●
asked in Qualtrics API
Linking Qualtrics Surveys to SQL Sever

Hello everyone!I would like to know if there is a possibility of making the connection between qualtrics and SQL Server directly.Thanks!

7584
S
R
Rahul
asked in Qualtrics API
Integrating Qualtrics with SQL database

I want to connect Qualtrics to SQL such that I can pull all survey data per a schedule into my SQL database? I tried searching this string but the only relevant thread is on bringing SQL data into a Qualtrics survey and not the other way. many thanks!

31685
S
LinaS
LinaS
posted in Qualtrics API
update embedded data with API

Hi I am wondering if anyone has experience using API to update values of embedded fields. I can only find insert embedded data fields API but can't find a way to update values. Any one can share their experience? Thanks.https://api.qualtrics.com/4afe452ecb6e2-insert-embedded-data-fields

12203
A
Level 2 ●●
Y
QPN Level 1 ●
Yazad_7QPN Level 1 ●
asked in Qualtrics API
Can we update embedded data subsequently once the responses have been collected

Hello all, Current situation We receive customer database and survey invites get sent out through Qualtrics. Along with the contact information we receive a lot of other useful information like 'region', 'customer type' etc. as embedded data fields. Challenge faced Some of the data fields are not updated in the data that flows through for surveys. Eg. - There may be blanks or may be incorrect data at times. However, business is able to share such data subsequently (after responses have been captured). So the way we currently analyse this is by downloading the completed responses from Qualtrics in excel, then do a Vlookup to match it with the updated information recieved for each respondent and subsequently analyse it manually. Key questions Q1. Are somehow able to update the embedded data in Qualtrics with the accurate data received separately? Eg. There is a sample of 1000 respondents (each having a unique ID) in Qualtrics but while viewing the data in the dashboards we realise t

10265
A
Level 2 ●●
V
Level 2 ●●
Vishal BediLevel 2 ●●
asked in Qualtrics API
Is there a way to do bulk update to response data though Qualtrics.

Is there a way to do bulk update to response data though Qualtrics.

6193
A
Level 2 ●●
H
hugoanda
asked in Qualtrics API
Using the API, how to export a response survey as PDF?

Hi everyone, as most of you have experienced, there is a way in the web app to export the responses of a specific participant as a PDF. I have been trying to replicate that step using the API. However, I cannot find a way on how to do it. It looks that currently there is no way do that process using the API, but I was wondering if there is a "hacky-way" that someone has found, or if there is another idea on how to export a specific response of a survey as a PDF? If anyone can shed some light on this question, I will appreciate it. Thanks.

4495
J
Level 2 ●●
B
Ben_Gilmore
asked in Qualtrics API
Is Text IQ available via API?

HiCan we send text to text iq and retrieve the output via an API? I had a hunt in the documentation and couldn't find anything that looked relevant.

2715
AlonsoC
Administrator
J
Julie_130
asked in Qualtrics API
Export Response API problem

I can’t seem to find the export file after running my API call. When I run this script in PowerShell, nothing seems to happen. The PowerShell screen empties and goes back to the original command prompt line. What am I missing?function Get-Qualtrics-Response-Export { param( [string] $organizationId, [string] $dataCenterId, [string] $apiToken, [string] $format, [string] $surveyId, [string] $outFile ) $hostName = "{0}{1}qualtrics.com" -f "$organizationId.".TrimStart('.'), "$dataCenterId.".TrimStart('.') # ---------------------------------------------------------------------------- # # # XML - Create Response Export # https://api.qualtrics.com/docs/response-exports # # ---------------------------------------------------------------------------- # $url = "https://$hostName/API/v3/responseexports" $requestHeaders = @{} #$requestHeaders.Add("Accept", "*/*") $requestHeaders.Add("X-API-TOKEN", "$apiToken")

280
J
J
jmobrien
asked in Qualtrics API
What is possible with the API for managing sharing/survey collaboration?

I'm new-ish to using the Qualtrics API, and will be using it more in the near future as I take the helm on working with a set (~130) of existing surveys from a longitudinal research project at a university. One task I will need to do relates to managing collaborators on an existing pool of surveys, and I'm trying to figure out whether I can use the API to do everything in a clean and reliable way. Here's the things I would like to be able to do right now: 1. Get information about who is shared on any given survey (I will have ownership-level control of any survey) 2. Get information about the permission levels associated with anyone shared on a particuar survey 3. Fix any given survey to a pre-specified list of collaborators who each have a pre-defined permission level, irrespective of the prior list of collaborators and their permissions It does seem like the "Share Survey" API call (https://api.qualtrics.com/reference#share-survey) provides much of the functionality to do #3.

3593
D
wkolcz
wkolcz
asked in Qualtrics API
Survey won't open twice when using the API

I am attempting to launch a survey via a button, via JS, on my website. When I use the JS function QSI.API.load() or QSI.API.run(), with the onclick, it works fine the first time but will not open the survey a second time until the page is refreshed. Is there a better API method or something I need to add to the button or survey to get it to perform the expected behavior? Thanks!

535
TusharDalwani
QPN Level 6 ●●●●●●

Motivational Playlist

Terms & Conditions