qualtRics
qualtRics copied to clipboard
ropensci
Feature: Download distribution history
Can we build a function to pull the distribution history? This aligns with the ability to know who bounced. In some instances, it's easiest to gauge true participation rates by filtering out the bounces. Additionally, the fact that I have to pull the history to get the participant list is why pulling the history would be helpful as the history pulls everyone the survey went out to.
It's not yet here in the main branch @Rory-OG but if you read through that other thread, I believe you can try out what @dsen6644 has built out in his fork. Definitely would love to get that figured out and ready for general use!
IMHO with the minor changes I suggested at the end of the #206 thread it should be ready to be merged in. I'm using @dsen6644's fork (with the changes) as part of my regular data collection.
That is great to hear!! 😄 @dsen6644 would you be interested in opening a PR?
I made a PR to @dsen6644's fork with the changes I've made. #217 comes into play. I have my method which might not be what you'd ultimately want included, but it's in my branch.
Sorry for the late response, I think for this to go into production we need two things.
- A warning/message specific to the
fetch_distribution_historyfunction that informs those with basic licenses that this function only works for XM directory users. Basic license users will receive a 404 error when calling the function. - We need a
fetch_distribution_historytest and its respective .yml file. Since I have a basic license I won't be able to run the test. For those who can, review #201 for workflow.
No worries at all about timing! @dsen6644 if you can open a PR with what you have already done and outline what you believe still needs to be done, we can get the other necessary things added in.
After merging in #239, I believe we still need this:
1. A warning/message specific to the `fetch_distribution_history` function that informs those with basic licenses that this function only works for XM directory users. Basic license users will receive a 404 error when calling the function.
We also should add a note to the documentation for the relevant functions that they require a certain kind of license.
Anything else still outstanding for this issue?
@dsen6644 originally included a call to list_distribution_links() in fetch_distribution_history(). There is some value to the data in the latter, without the former, though it's limited in my opinion. Basically, if someone wanted some aggregate status metrics (like % of emails opened) then you could just use distribution history. You can get that from Qualtrics' web site, but this would allow it to be automated if you wanted to report on it (I use these stats as a barometer on our survey methodology effectiveness).
The links allow one to connect the status of the invitation to the individual respondent. While I was reporting aggregate metrics it was part of a data model that had an invitation_id as the key and I needed the emails in order to join the status back to the invitation. Then, if someone was filtering the data model on some other attribute the methodological metrics would update to reflect that.
Someone can always join the links to the history manually, but I didn't want to passively drop the convenience that @dsen6644 originally built in.
I'm closing #206 as my original request was fulfilled. If you want to embed the one function in the other, or include the warning message, then this could attached to this issue.