Show Study predicted recruitment time

Returns the predicted recruitment time for the study 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

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

study_idstringRequired

Study id

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	import requests
2
3	url = "https://api.prolific.com/api/v1/studies/study_id/predicted-recruitment-time/"
4
5	headers = {"Authorization": "Token <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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

Path parameters

Response

Errors