Qualtrics API | XM Community
Skip to main content

Qualtrics API

Discuss API solutions, best practices, and more.

  • 1,048 Topics
  • 2,449 Replies
1048 Topics
M
muriah
asked in Qualtrics API
Hitting a KeyError when attempting to extract an array of survey data

I've managed to cobble together a script from the Qualtrics samples that gets a list of all of the surveys associated with my apiToken and then exports all active surveys into a folder. Unfortunately, I've found that if I just create an array of all of my surveyIds where isActive == True, I get a KeyError on the following line (Python): progressId = downloadRequestResponse.json()["result"]["id"] If I run a check on ownerId, I don't get the KeyError. However, not all of my surveys are extracted. It's super weird and I'm a bit at a loss. Anyone have any ideas of how I might fix this? ~~~~ import os import requests import json import zipfile try: import simplejson as json except ImportError: import json Setting user Parameters apiToken = 'APITOKEN' dataCenter = 'DATACENTER' Constructing the URL baseUrl = "https://{0}.qualtrics.com/API/v3/surveys".format(dataCenter) headers = { "x-api-token": apiToken, } Getting the json data json_data = requests.get(baseUrl,headers=heade

1480
Emily
Qualtrics Employee
6 years ago
S
simon
posted in Qualtrics API
Including custom data in API imported responses

I'm wanting to include some custom data in responses that I'm uploading via the API’s `/V3/responseimports` endpoint. How am I able to just include any data for it to be visible in the responses. Currently it just seems to ignore any columns it doesn't know about.

80
S
6 years ago
U
Level 3 ●●●
uhrxx005Level 3 ●●●
asked in Qualtrics API
Exporting in-progress responses is broken. Can I use the API as a workaround

For one of my projects I have been unable to export my in-progress responses. I have just over 12,000 in-progress responses but whenever I try to export them the data file only contains around 200 individuals. Qualtrics has been aware of the problem and trying to fix it for the last 6 weeks with no luck. I really need the list of in-progress individuals and was wondering if there would be any way to use the API to get this list?

310
MohammedAli_Rajapkar
QPN Level 5 ●●●●●
6 years ago
M
marty2000
asked in Qualtrics API
Pulling report data via API

Hi, I have a customer using Qualtrics, I'm developing a website for them where we want to display some high level report data from the survey. I can see in Qualtrics that reports can be defined which is great, all I would like to do is read this data on demand, via the API. I can't see anything about this in the API docs, I'm hoping that I'm looking in the wrong place... Note: I can see that you can retrieve all the data via the API and it is technically possible for me to do this and generate the report myself, however the client does not want to grant the website access to the raw data for privacy reasons. The only other solution I can come up with is to email the report (daily) as a CSV and write a system to read from the mailbox, parse the results from the CSV attachment and push the data into our database etc, this is not a very robust solution so it's a last resort.

1080
MohammedAli_Rajapkar
QPN Level 5 ●●●●●
6 years ago
B
bkodela3_Schneider
asked in Qualtrics API
How to update a recorded responses' answer?

Hi, We are using embedded fields in survey to pre-populate values with in the responses. Once the response is submitted, updating the embedded fields (using update response API) is not showing up in the response (as answers) rather it is still showing the old values. When i download the response in PDF , i can see the embedded field values updated but the answers are still showing the old numbers. Is there a way to force or update an answer of a recorded response. Thanks, Bkodela

6900
Rich_Boits_Walker
QPN Level 3 ●●●
6 years ago
I
igress
asked in Qualtrics API
Get ContactID for a Response

Hi, Is there a way to get the ContactId of the response. Currently when I export the response data for a survey via API, the csv has a Recipient email/first name/last name etc however it does not have any ContactId. Background: Currently I am trying to create prototype and in order to relate the response data to contact data I am doing the following: (1) That gets a Survey data for an SurveyID (2) Get's the Distribution list and MailingListID (I have only 1 distribution list) (3) Get's the contacts from the Distribution list (4) Download the response data (5) Join the response data to contact data based on email address (6) Save it to another database I don't want to use the email as the "Joining" entity. Thanks

7680
AravindA
Qualtrics Employee
6 years 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.

990
AravindA
Qualtrics Employee
6 years ago
J
Juan
asked in Qualtrics API
Where to get the directoryId

I am trying to use the transactionbatches API call, For that call you need a directoryId. Can this be obtained using an API call.

2900
AravindA
Qualtrics Employee
6 years ago
P
PESO
asked in Qualtrics API
Export status of partial responses in progress via the API

Hi all, I'm using python to access the v3 API in Qualtrics. I'm having no problem using _responseexports_ to get the full response set of completed responses, but can't seem to find a REST API call to get information on in progress and responses that have not yet been started. This is a survey in which I generated individual links per respondent, but any API call to just get a list of partial responses and either the currently answered record or the recipient email / embedded data is all I need. I have the export of the links in a spreadsheet, and so even if I can programmatically get a list of users that have begun the survey would give me most of what I need to know. Any thoughts? It seems like this should be a core part of the API.

2070
MohammedAli_Rajapkar
QPN Level 5 ●●●●●
6 years ago
S
Stap
posted in Qualtrics API
Has anyone connected Qualtrics to Krealinks via API?

We currently use Krealinks to run our Research community, and have connected it to Qualtrics Via API. I would like to know if there's anyone else who currently has a similar setup and how you find it?

1090
S
6 years ago
Piotr
Piotr
asked in Qualtrics API
Adding contact to contact list using API 2.5 query

Hey! I am working on the query using Qualtrics API 2.5, which would add contact to contact list. I struggling with adding custom embedded data to the query. I have added manually this embedded data to list, and now i would like to know what is the query syntax to put the value into it. It is pretty simple for existing embedded data like FIrstName and LastName. My query looks like this ( pls don't focus on the focus on the beginning, it's just a concept.) In the below concept i would like to put specific value (SV_XXXXXX) to embedded data named SV. How it should be written? www.XXXXXXXXX&FirstName=Piotr&LastName=Siudak&SV=SV_XXXXXX

340
Piotr
6 years ago
A
AmandaJia
asked in Qualtrics API
Does anybody know how to import a batch of choices to a specific questions?

the way to import a large number of choices to a specific questions?

8170
bstrahin
Level 6 ●●●●●●
6 years ago
D
dmccarvi
asked in Qualtrics API
Creating quotas through the API?

Is it possible to create/manage quotas through the API? I've perused the API documentation and the quotas help page, but didn't see this mentioned on either. I'm using Research Core and v3 of the API.

1580
AnthonyR
Level 4 ●●●●
6 years ago
J
Joe
posted in Qualtrics API
Failure of getSurvey() in the R API

Hi I have been using the R API successfully to pull my data in for statistical analysis and reporting. However, I have not used in about 3 months and when I came back to do this work I was unsuccessful. Here are my steps and error. registerOptions(api_token=APIkey, root_url=baseURL) surveys <- getSurveys() surveys This produces the list of surveys table shown in https://api.qualtrics.com/docs/response-exports Survey Table in R | | id | name | ownerId | lastModified | isActive | | --- | ------------------- | -------------- | --------------------- | ------------------- | :---------: | | | SV_0fHnuNimdt3R9pX | Newer Name | UR_123456789012345 2 | 017-05-25T22:15:22Z | TRUE | | | SV_0zSlknmZXhJ4BAx | TestFromURL | UR_123456789012345 2 | 017-05-24T20:26:13Z | FALSE | | | SV_0x1XmEv9pCD2asB | Test | UR_12345678

610
RTSullivan
Level 2 ●●
6 years ago
I
igress
asked in Qualtrics API
Update contact with no MailingListId

Hi, I have created a survey project and under distributions I clicked compose email and send the email by selecting an individual. The json response for the distribution looks like: { 'meta':{ 'httpStatus':'200 - OK', 'requestId':'aa1a5de9-94e7-4688-fasdfsdf-fsdfasdfasdf' }, 'result':{ 'elements':[ { 'createdDate':'2018-03-15T15:57:04Z', 'headers':{ 'fromEmail':'noreply@qemailserver.com', 'fromName':'test', 'replyToEmail':'test', 'subject':'test' }, 'id':'EMD_sdfasdf', 'message':{ 'libraryId':None, 'messageId':None, 'messageText':None }, 'modifiedDate':'2018-03-15T15:57:20Z', 'organizationId':'fasdfds', 'ownerId':'UR_fsdfasd', 'parentDistributionId':None, 'recipients':{ 'contactId':'ML

240
Michael_Campbell_RedPepper
QPN Level 3 ●●●
6 years ago
Barnaby
Qualtrics Employee
BarnabyQualtrics Employee
asked in Qualtrics API
Survey Respondent Landing Page

Can I create a landing page that lets my respondents know which surveys they have taken so far?

3670
G
6 years ago
Poppy
Qualtrics Employee
PoppyQualtrics Employee
asked in Qualtrics API
I want to randomly assign a 4-digit ID to every respondent with no repeats.

I want to randomly assign a 4-digit ID to every respondent with no repeats (we anticipate ~500 responses). How could I set this up?

1170
Michael_Campbell_RedPepper
QPN Level 3 ●●●
6 years ago
S
Suriya
asked in Qualtrics API
Validation : Side by side Question Type

! Hi Team, I have created a side by side question. Participants should select radio button for each row . And next column text entry are optional. Could you please help me on this. If i select force response option, the entire question is required response. only first column is mandatory and second column text box is non mandatory. Could you please help me on this. Regards, Sadeesh

810
S
6 years ago
M
MarshiyaHerbert
asked in Qualtrics API
How do I identify the messageId associated with my survey

My organization has a survey set up and I am trying to create survey distribution (https://api.qualtrics.com/docs/create-survey-distribution). I am not sure what the messageId in the payload should be and where to look for it.

3330
MichelleC
Level 3 ●●●
6 years ago
P
PioKol
asked in Qualtrics API
Get contact API request + embedded data

Hi! I'm starting qnr with URL like this: https://aaa.qualtrics.com/jfe/form/SV_aaaaaaaa?myID=MLRP_asasasaasa And I want to use in embedded data values retrieved from API command: https://yourdatacenterid.qualtrics.com/API/v3/mailinglists/:mailingListId/contacts/:contactId I tried to use on start webservice https://aaa.qualtrics.com/API/v3/mailinglists/ML_aaaaaa/contacts/${e://Field/myID}, but it doesn't work. Any suggestion appreciated. Regards, Piotr

710
P
6 years ago
RachelTHREE
Level 2 ●●
RachelTHREELevel 2 ●●
asked in Qualtrics API
Automated Emails with Data

Hey all! I know that in Research Core you have the ability to send yourself (and others) emails with results/reports on a regular basis, but is there an automated way to send yourself data/data files? For example, if possible, I'd love to be able to send myself data from the past week every Monday.

4600
Akdashboard
Level 4 ●●●●
6 years ago
Goldie
Qualtrics Employee
GoldieQualtrics Employee
asked in Qualtrics API
How can I opt out of multiple TA mailing lists at once?

I'm using Target Audience and I am going to have a few different surveys being distributed at any given time. I don't want to let my clients opt out of my entire directory, but I'd like them to be able to opt out of more than one list at once. Is this possible?

340
AnthonyR
Level 4 ●●●●
7 years ago
Dax
Qualtrics Employee
DaxQualtrics Employee
asked in Qualtrics API
Unzipping a file from GET Response Export

When I run the Get Response Export file call and choose "Send and Download," I am able to create a .zip file, but when I try to unzip the file it archives the file instead of opening and unzipping it. How can I get the file to open?

1060
AnthonyR
Level 4 ●●●●
7 years ago

Motivational Playlist

Terms & Conditions