Insight Platform - Common API Questions | Qualtrics

Common API Questions

Introduction

Qualtrics has variety of different products that allow our clients to gather actionable data in real time. Some of these products include the Survey Platform, Site Intercept, Target Audience, and Qualtrics 360. Once you’ve purchased the Qualtrics API feature, you’ll be able to use the API for any products that are a part of your license.

Survey Platform

I received an error message from my API request that says, “Incorrect Username or Password.” Why am I seeing this error message?
If you’re seeing this error message, you are using an incorrect username for the parameter User. Do not use your User Id found in the Qualtrics Ids page. Instead, use whatever username you enter to log into your account.
I have all the correct parameters, but I keep getting an error message that says “Invalid request. Missing or invalid parameter Request.” Why is this happening?

Example:

https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?API_SELECT=ControlPanel&Version=2.4&request=addRecipient&User=username&Token=11lyq2nmuBbpKD5gfxTbqF2Sm2BTHplJreCvCuzQ&Format=XML&LibraryID=UR_6FmmzmE470uARsV&PanelID=ML_exKUSyDiQ42UNrD&FirstName=Test&LastName=Test&Email=test@qualtrics.com

Qualtrics API parameters are case sensitive. Your parameter is being called “request” in this example when it should be “Request.” Capitalize the parameter and you’ll be able to successfully run your API request.

I would like to download my raw data to open in Excel. Which API request should I use?
You’ll want to use the getLegacyResponseData request to download your raw data. Once the request has been successful, you’ll find a CSV file in your computer’s downloads. You can find the details for this request in the Survey Platform API documentation, under Responses Requests.
When using importPanel, what are the different methods of posting or sending my contact list to Qualtrics?
When importing a contact list into Qualtrics, your contacts should be saved as a CSV file. You have two options for passing your contact list to the Qualtrics API:

  1. You can host the CSV file with your contacts on a website. If you’re hosting your CSV file on the internet, you’ll want to use the URL parameter for the importPanel request. This method is called the Get method.
  2. You can post your contact list in the body of the API request by using the Post method. You won’t need to use the URL parameter, and will instead instruct your API request to search for your file on your computer. This method requires custom coding or an application such as Postman that can run Post requests.
Am I limited to the number of requests I can make for my organization? And how many concurrent API requests can I make at once?
Qualtrics doesn’t restrict the number of requests you can make for your license in total. However, Qualtrics does limit the number of concurrent requests your organization can make at one time. Your organization is allowed 15 concurrent download requests and 50 non-download concurrent requests.
I’m using the importSurvey request, and I’ve saved my survey as a TXT file. The request is successful, but my questions aren’t appearing in my newly imported survey. Why is this happening?
You’ll need to make sure that you’re following the necessary format for importing surveys into Qualtrics. To learn more about TXT formatting, view Preparing a TXT File in Simple Format and Preparing a TXT File in Advanced Format. Once your file is formatted correctly, the request will run successfully.
I’m using the request getLegacyResponseData with the parameters StartDate and EndDate. When I look at the downloaded data though, I’m not seeing the anticipated date range of responses.
The key to using the StartDate and EndDate parameters is understanding what date value is being used to evaluate the condition you’re creating (i.e., what dates are being looked at to evaluate the StartDate you set and the EndDate you set). These two parameters are using the date the participant started the survey. This value, called the Start Date, can be found in your Responses module and downloaded data.So if you set your parameter StartDate to be 2015-01-01 and your parameter EndDate to be 2015-01-02, you will download responses that have been recorded (submitted or partial completes) for survey participants that started their survey within date range January 1, 2015, to January 2, 2015.

Qtip: A survey response doesn’t become recorded until the participant clicks the submit button inside of a survey or when the Partial Completion time frame has been met.

Site Intercept

For Site Intercept questions, contact our Site Intercept support team at +1 (800) 340-9194.

Target Audience

Can I use the Survey Platform API now that I’m using Target Audience too?
Yes, absolutely. Target Audience has a few API requests that will replace requests made through the Survey Platform API, but for the most part you can still use all of the Survey Platform API requests. The Panel Requests are the only ones that may change.For example, instead of using the importPanel request to create a panel through the Survey Platform’s API, you would use the importContacts request to add contacts to a mailing list or your directory in Target Audience.

For requests like getLegacyResponseData to download your data or sendSurveyToIndividual to send a survey invite to a contact, you would still use those requests from the Survey Platform API.

What additional functionality does the Target Audience API provide that I don’t have access to with just the Survey Platform API?
The Target Audience API provides you with a few unique requests specific to Target Audience. You can use getBouncedContacts to find all the contacts in your directory, or in a specific mailing list, that have ever had an email bounce. The getDirectoryContacts request can be used to export a subset of your entire directory. The getIncentiveRecipients request allows you to download a list of every contact in your directory who has earned a specific incentive, such as a points reward or sweepstakes entry. These requests and others are available with the Target Audience API.
What is the difference between the Contact ID and the Recipient ID?
Each Target Audience API request typically asks for the contact’s Contact ID. This ID begins with “CID_” and is followed by a unique alphanumeric string. The Contact ID is the contact’s unique ID in your directory.Some API requests (such as getListContacts, getSampleContacts, removeContact, or sendSurveyToIndividual) ask for the contact’s Recipient ID. This ID begins with “CGC_” and is followed by a unique alphanumeric string. The Recipient ID is the contact’s unique ID in a mailing list.

To understand the difference between the Contact ID and the Recipient ID, it’s important to remember that each contact should only exist in your directory once. So a single contact could be found in your directory once but be a member of multiple mailing lists. If this contact were a member of three mailing lists, he or she would have one Contact ID and three Recipient IDs, one for each list.

Qualtrics 360

For Qualtrics 360 questions, contact our Qualtrics 360 support team at +1 (800) 340-9194.