Migrate over to New Response Exporter

[Jaseibert]

Qualtrics will soon be deprecating the legacy response exporter, so I will be building out the methods for the new exporter. I will also work to include an option to select labels or values as exports.

[kgweber-sag]

Delighted to hear it, I came here to ask whether label/value was an option you were thinking about or whether I should write my own subclass.

[Jaseibert]

@arfenarf I will try to get to it this weekend when I have some time. If you want to subscribe to this thread, I will post the new migrated method and how to use.

[Jaseibert]

@arfenarf @YukunYangNPF I just implemented a fix to the enhancement request about exporting responses with labels. You will need to install the latest version of the package. Use pip install QualtricsAPI==0.4.8 or pip3 install QualtricsAPI==0.4.8 depending on your python installation. Feel free to reach out with questions about usage.

Then to get the responses use:

#1. Import the dependencies
from QualtricsAPI.Setup import Credentials
from QualtricsAPI.Survey import Responses

#2. Set your credentials
Credentials().qualtrics_api_credentials(token='<Your API Token>',data_center='<Your Data Center>')

#3A. Calling get survey responses will return responses using only the categorical labels
df = Responses().get_survey_responses(survey='<Survey ID>', useLabels=True)
df.head()

#3B. Calling get survey responses will return responses with numeric recode values and categorical labels
df = Responses().get_survey_responses(survey='<Survey ID>', includeLabelColumns=True)
df.head()

#3C. Calling get survey responses will return responses with numeric-only recode values
df = Responses().get_survey_responses(survey='<Survey ID>')
df.head()

#4. You may need to use the new question method also.
df = Responses().get_survey_questions(survey='<Survey ID>')
df.head()

Optional Parameters for Responses().get_survey_responses()

• useLabels (bool): Instead of exporting the recode value for the answer choice, export the text of the answer choice. For more information on recode values, see Recode Values on the Qualtrics Support Page.
• includeLabelColumns (bool): For columns that have answer labels, export two columns: one that uses recode values and one that uses labels. The label column will has a IsLabelsColumn field in the 3rd header row. Note that this cannot be used with useLabels.
• exportResponsesInProgress (bool): Export only responses-in-progress.
• limit (int): Maximum number of responses exported. This begins with the first survey responses received. So a Limit = 10, would be the surveys first 10 responses.
• seenUnansweredRecode (int): Recode seen-but-unanswered questions with this value.
• multiselectSeenUnansweredRecode (int): Recode seen-but-unanswered choices for multi-select questions with this value. If not set, this will be the seenUnansweredRecode value.
• includeDisplayOrder (bool): If true, include display order information in your export. This is useful for surveys with randomization.
• endDate (str): Only export responses recorded after the specified UTC date time. You can use various date styles. One common format: (2020-01-13 13:30)
• startDate (str): Only export responses recorded after the specified UTC date time. You can use various date styles. One common format: (2020-01-13 13:30)
• timeZone (str): Timezone used to determine response date values. If this parameter is not provided, dates will be exported in UTC/GMT. See Qualtrics Dates and TimeZones for the available timeZones.

[kgweber-sag]

Awesome!

Should setup.py be calling for python-dateutil instead of just dateutil?

[Jaseibert]

@arfenarf Great Catch! I merged your fix and it will be reflect in v0.4.9. Let me know if you have any other issues.