Skip to content

Commit 397a3de

Browse files
Finish instructions
1 parent 2a9ee75 commit 397a3de

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,35 @@ Before you can use the functions, you need to:
88

99
* Input your Qualtrics API token in qualtrics_settings.py. You can get it by going to Qualtics --> click on your username --> Account settings
1010

11-
* Add a survey ID in qualtrics_settings.py. It can be found in the URL of your survey, starting with the letters SV. You can add multiple survey IDs to qualtrics_settings.py, and you can name them whatever you want. This step isn't required, but makes it easy to refer to different surveys when running the functions.
11+
* Add a survey ID in qualtrics_settings.py. It can be found in the URL of your survey, starting with the letters SV. You can add multiple survey IDs to qualtrics_settings.py, and you can name them whatever you want. You can use the Survey ID without adding it to the settings, but makes it easy to refer to different surveys when running the functions.
12+
<img width="302" height="37" alt="image" src="https://github.com/user-attachments/assets/be89e2ed-afec-426a-8482-1c43ba961fb0" />
1213

1314
* Manually add some contacts to the survey. The functions assume that the contacts are set up in a cetain way, where the ExternalDataReference = another field, which has been turned into an embedded field. It's only possible to set it up manually the first time. If they survey is new, add some respondents from a CSV first before using the functions.
1415

1516
### Adding someone to a survey
1617

1718
**Step 1: Find DistributionID**
1819

19-
Your survey may contain multiple Personal Links distributions. A distributions is the channel by which a survey is sent out to respondents. You must find the DistributionID of the one that you want to add a person to. You can use the function get _distributions(). In the first parameter, fill in the SurveyID of your Survey.
20+
Your survey may contain multiple Personal Links distributions. A distributions is the channel by which a survey is sent out to respondents. You must find the DistributionID of the one that you want to add a person to. You can use the function **get _distributions()**. In the first parameter, fill in the SurveyID of your Survey.
2021

21-
The DistributionID always starts with EMD_. In the example, the survey has two distributions. Run the function to get the DistributionID and date created of each one, so you can easily choose the one you want. In this case, you want test_contact_list.
22+
The DistributionID always starts with EMD_. In the example, the survey has two distributions, which I can see on Qualtrics. Run the function to get the DistributionID and date created of each one, so you can compare creation dates and choose the one you want. In this case, you want test_contact_list. Copy the DistributionID.
2223

23-
<img width="602" height="326" alt="image" src="https://github.com/user-attachments/assets/c94e87cd-0e83-4479-951f-4e8b7dd581b9" />
24+
<img width="391.3" height="211.9" alt="519083748-c94e87cd-0e83-4479-951f-4e8b7dd581b9" src="https://github.com/user-attachments/assets/acee553b-9005-44fc-b1fb-cd5ce22480b4" />
2425
<img width="555" height="59" alt="image" src="https://github.com/user-attachments/assets/651de9d5-65fd-49cb-aced-37312548a45d" />
26+
<br/><br/>
2527

2628
**Step 2: Add an individual to a Survey**
2729

2830
You add a new individual to a survey by adding them to a distribution. A distribution is always linked to exactly one mailing list. Therefore, you must add this individual to the mailing list.
2931

30-
Use the function add_individual_to_survey(). The first argument is the person’s Study ID, which is internal to the given study. The second argument is the Qualtrics ID of the survey. The third is the distribution_id found in step 1.
32+
Use the function **add_individual_to_survey()**. The first argument is the person’s Study ID, which is internal to the given study. The second argument is the Qualtrics ID of the survey. The third is the distribution_id found in step 1.
3133

3234
The function adds this individual’s Study ID to the right mailing list, which in turn adds it to the distribution. If the Study Id already exists in this mailing list, it won’t be added again and you’ll get a warning.
3335

3436
The individual’s Personal Link to the survey is printed.
3537

3638
### Getting someone's progress on a survey ###
3739

38-
Use the get_individual_progress() function. The first argument is the individual’s Study ID. The second is the field being used as the Emebedded Data Field (for example, "study_id_child"). The third is the ID of the survey.
40+
Use the **get_individual_progress()** function. The first argument is the individual’s Study ID. The second is the field being used as the Emebedded Data Field (for example, "study_id_child"). The third is the ID of the survey.
3941

40-
The function works by requesting an export from Qualtrics, waiting for it, downloading it, and then filtering for the person's ID. If we wanted to get multiple individuals’ progress at once, the function could be modified to filter for multiple study IDs.
42+
The function works by requesting an export from Qualtrics, waiting for it, downloading it, and then filtering for the person's ID. If we wanted to get multiple individuals’ progress at once, the function could be modified to filter for multiple study IDs.

0 commit comments

Comments
 (0)