Show Study predicted recruitment time

Returns the predicted recruitment time for a study that has not even been saved as a draft if it was published right now, based on a machine learning model. The recruitment time is the time from publish to the time when the final participant starts their submission. It does not account for the time to complete the submission.

Authentication

Authorizationstring

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Request

This endpoint expects an object.

filterslist of objectsRequired

List of filters to apply to the count. This parameter uses the new, simplified filters schema for interacting with eligibility.

workspace_idstringRequired

The ID of the workspace the study will be created in.

rewarddoubleRequired>=1

How much are you going to pay the participants in cents. We use the currency of the workspace

study_typeenumRequired

Type of study.

total_available_placesdoubleRequired>=1

How many participants are you looking to recruit

estimated_completion_timedoubleRequired>=1

Estimated duration in minutes of the experiment or survey

device_compatibilitylist of enumsOptional

Add all devices that participants can use. You can include one or more options.

Allowed values:

peripheral_requirementslist of enumsOptional

Add all requirements that participants have to meet.

Allowed values:

study_labelsenumOptional

The field that the study is about to get tagged with.

Response

Return the predicted recruitment time for the study

precise_recruitment_time_hoursdouble or null

The predicted recruitment time in hours

lower_bound_hoursdouble or null

The lower bound of the predicted recruitment time in hours

upper_bound_hoursdouble or null

The upper bound of the predicted recruitment time in hours

display_stringstring or null

A human-readable string representing the predicted recruitment time

limit_atdouble or null

The limit at which the accuracy of the prediction becomes unstable. This should be used when rendering the recruitment times in a GUI. For example if the limit_at is 10, and the predicted recruitment time is 12 hours, the display string should be “10 hours+”. This has been done for you in the display_string field.

1	curl -X POST https://api.prolific.com/api/v1/studies/predicted-recruitment-time/ \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"filters": [
6	{
7	"filter_id": "first-language",
8	"selected_values": [
9	"1",
10	"2"
11	]
12	}
13	],
14	"workspace_id": "74581909c0265l1da4a71092",
15	"reward": 100,
16	"study_type": "SINGLE",
17	"total_available_places": 30,
18	"estimated_completion_time": 1,
19	"device_compatibility": [
20	"mobile",
21	"tablet"
22	],
23	"peripheral_requirements": [
24	"audio",
25	"microphone"
26	],
27	"study_labels": "survey"
28	}'

1	{
2	"precise_recruitment_time_hours": 2.13,
3	"lower_bound_hours": 1.5,
4	"upper_bound_hours": 2.5,
5	"display_string": "1 hour 23 minutes",
6	"limit_at": 1.1
7	}

Authentication

Request

Response

Errors