PRprolific
studies

Get taskflow progress

Changed on

Returns per-URL allocation progress for a Taskflow study (studies configured with access_details). Each item in progress corresponds to one external_url from the study's access details, including how many participants are allocated and any screenout-driven capacity increments.

Returns 404 if the study has no access-details collection (not a Taskflow study).

get/api/v1/studies/{id}/access-details-progress/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/studies/{id}/access-details-progress/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Study id

Response

Taskflow progress for the study's access details collection.

idstring required

The access details collection ID for this study's Taskflow configuration.

_linksobject

HAL-style links; typically includes self pointing at this endpoint.

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-study-access-details-progress removed and replaced with studies_GetStudyAccessDetailsProgress