PRprolific
filters

Count participants

Changed on

Count how many participants meet all the given filters. Only participants that pass every one of the filters are counted. Zero means that there are less than 5 participants. We do not show lower numbers to protect the privacy of the participants.

To see a list of filters that may be passed to this endpoint, see the documentation for filters.

post/api/v1/eligibility-count/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/eligibility-count/
  • Auth
    API key in header Authorization

Request body

workspace_idstring

The ID of the workspace you will be creating a study in.

Due to US tax laws, non US residents may not participate in studies created by US researchers. For this reason, we use the country specified in the workspace to determine eligibility.

If you do not specify a workspace ID, we will use the current workspace ID of the user making the request. Your eligibility count may not be accurate if you do not specify a workspace ID.

organisation_idstring

The ID of the workspace you will be creating a filterset in.

Response

Count

countnumber double required

Number of participants passing all the requirements

Changes

  • 9cabd62d103fRevision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property //////

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API