Longitudinal or multi-part studies

View as Markdown

This cookbook covers how to run longitudinal or multi-part studies using Prolific’s API. Longitudinal studies involve collecting data from the same participants over multiple time points, while multi-part studies involve multiple related data collection sessions.

Overview

To run a longitudinal study on Prolific, you set up one Prolific study per time-point and invite the same participants back to each one. For each individual study, you should set the completion time and reward per participant to reflect what participants will be required to do within that stage of the experiment only.

For example, if you’re running a 2-part longitudinal study with an overall reward of $3.00 and each part takes 10 minutes to complete, you would set this up as:

  • Study 1: Estimated completion time 10 minutes, reward per participant $1.50
  • Study 2: Estimated completion time 10 minutes, reward per participant $1.50

When participants have completed both parts of the study, you can approve both of their submissions so that they are paid the full $3.00 reward.

Important: The reward rate for each individual study across a longitudinal study on Prolific must meet our minimum reward rate of £6 / $8 per hour.

Use cases

  • Long-term research studies
  • Follow-up data collection
  • Multi-session experiments
  • Tracking changes over time

Step-by-step guide

1

Create the first study

Create your initial study for the first time-point. This study should have:

  • A clear description explaining the full structure of your study, especially if payment is contingent upon participation in follow-up stages
  • Reward and estimated completion time that reflect only this stage of the study
POST
https://api.prolific.com/api/v1/studies/
Body

Make a note of the study id from the response as you will need this in the following steps.

2

Publish the first study

Publish the study to start recruiting participants.

POST
https://api.prolific.com/api/v1/studies/:id/transition/
Path Parameters
Body

Once the study has successfully published, the study’s status will be ACTIVE. Wait for participants to complete the study before proceeding to the next step.

3

Get participant IDs from the first study

Once participants have completed the first study, you need to retrieve their participant IDs to create a custom allowlist for your follow-up studies.

If your survey software supports recording participant IDs from a URL parameter, you can collect participant IDs directly during the first study. Make sure to include the PROLIFIC_PID URL parameter in your study url to capture this information. You can find more information on using URL parameters in the URL parameters guide.

You can also get your participant IDs by getting the submissions for your study.

GET
https://api.prolific.com/api/v1/studies/:id/submissions/
Path Parameters

From the response, extract the participant_id from each submission you would like for your follow up studies.

You can also export the demographic data which includes participant IDs:

POST
https://api.prolific.com/api/v1/studies/:id/demographic-export/
Path Parameters
Body

Next make a note of all the participant IDs as you will need them to create a custom allowlist for your follow-up studies. A custom allowlist ensures only participants who completed the first study are eligible for subsequent parts.

4

Create follow-up studies with custom allowlist

For each subsequent time-point, create a new study. Each follow-up study should:

  • Have reward and estimated completion time that reflect only that stage of the study
  • Use a custom allowlist filter to ensure only participants from the first study are eligible
  • Include a clear description explaining it’s part of a longitudinal study

To use a custom allowlist, include a filter with filter_id set to custom_allowlist and selected_values containing the array of participant IDs you collected from the first study.

POST
https://api.prolific.com/api/v1/studies/
Body

Multiple conditions: If you have multiple conditions and want to keep these conditions consistent between studies, you will need to set up a separate follow-up study for each condition and add only those participants you want to be eligible to each study’s custom allowlist. However, you will only need to run one study for the first part if your survey software supports allocation to conditions from one URL.

Make a note of each follow-up study id as you will need them to monitor and approve submissions.

5

Publish follow-up studies

Publish each follow-up study when you’re ready to collect data for that time-point.

POST
https://api.prolific.com/api/v1/studies/:id/transition/
Path Parameters
Body

You can publish all follow-up studies at once, or publish them at different times depending on your study design. If you want your participants to complete the follow-up studies at particular times, make sure to specify this clearly in your study description, including the time zone(s).

6

Monitor study progress

Check the status of your studies to see how many participants have completed each part.

GET
https://api.prolific.com/api/v1/studies/:id/
Path Parameters

You can also check submission counts for each study:

GET
https://api.prolific.com/api/v1/studies/:id/submissions/counts/
Path Parameters
7

Review and approve submissions

Once participants have completed all parts of your longitudinal study, you can review and approve their submissions. You can get submissions for each study:

GET
https://api.prolific.com/api/v1/studies/:id/submissions/
Path Parameters

Payment timing: If your study consists of multiple waves within 21 days, you can wait until the final wave is complete before paying each wave. To do this, leave the submissions from the earlier studies as ‘awaiting review’ until you are ready to approve them. Submissions will be automatically approved after 21 days if they are still awaiting review at this point.

If the waves are over a longer period, all participants from each stage will need to be approved within 21 days.

To approve a submission, use the submission id and transition it to APPROVED:

POST
https://api.prolific.com/api/v1/submissions/:id/transition/
Path Parameters
Body

You can find more information on reviewing submissions in the submissions guide.

More information

You can find more information on running longitudinal studies in this guide on Prolific’s researcher help center.

The guide goes into detail on best practices for:

  • Additional considerations when designing longitudinal studies
  • FAQs about longitudinal studies

Help & support

For questions and requests specific to using Prolific’s API, you can reach our support team through this form.