API ReferenceStudies

Show Study predicted recruitment time

View as MarkdownOpen in Claude
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

AuthorizationToken

Header authentication of the form Token <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.

Errors