Fetch data from qualtrics via API

[JamesPHoughton]

In https://github.com/Watts-Lab/deliberation-empirica/issues/426, we made qualtrics work in an iframe, but the data doesn't make its way back to empirica anywhere. We should have a callback on the server that uses the qualtrics API to fetch this data and attach it to the player object.

[JamesPHoughton]

Thinking about using a third party API wrapper:

1. Connect to API using third party wrapper: https://www.npmjs.com/package/qualtrics-api

2. Set Environment Variables

   • QUALTRICS_API_TOKEN - Get a API token using instructions: https://www.qualtrics.com/support/integrations/api-integration/overview/#GeneratingAnAPIToken
   • QUALTRICS_BASE_URL - Get base URL using instructions: https://api.qualtrics.com/ZG9jOjg3NjYzMw-base-url-and-datacenter-i-ds Base URL = https://iad1.qualtrics.com/API
   • QUALTRICS_DEFAULT_DIR Get default directory from the same page as the datacenter ID and API token

Challenge of knowing

Using raw API:

As we really only want to make one API call: https://api.qualtrics.com/1179a68b7183c-retrieve-a-survey-response The API endpoint takes a responseId parameter:

https://yul1.qualtrics.com/API/v3/surveys/{surveyId}/responses/{responseId}

But what we get from the end of survey message on the browser is the sessionId.

https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/standard-elements/embedded-data/

There may be an informal relationship between sessionId and responseId. Test survey 1

• sessionId = FS_3kjHHr6XVzl6RlV
• responseId = R_3kjHHr6XVzl6RlV

Different survey

• sessionId = FS_2q4tCzVMrEPYKXB
• responseId = R_2q4tCzVMrEPYKXB

Looks like we can just replace the FS_ with R_.