Create filter set | Prolific API

curl -X POST https://api.prolific.com/api/v1/filter-sets/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "workspace_id": "644aaabfaf6bbc363b9d47c6",
  "name": "Ambidextrous teenagers",
  "filters": [
    {
      "filter_id": "handedness",
      "selected_values": [
        "2"
      ]
    },
    {
      "filter_id": "age",
      "selected_values": [
        "19",
        "20",
        "21",
        "22"
      ]
    }
  ]
}'

{
  "id": "644ab312af6bbc363b9d47c7",
  "version": 1,
  "is_deleted": false,
  "is_locked": true,
  "workspace_id": "644aaabfaf6bbc363b9d47c6",
  "organisation_id": "5f8d0d55b54764421b7156c3",
  "name": "Ambidextrous teenagers",
  "filters": [
    {
      "filter_id": "handedness",
      "selected_values": [
        "2"
      ],
      "weightings": {}
    },
    {
      "filter_id": "age",
      "selected_values": [
        "19",
        "20",
        "21",
        "22"
      ],
      "weightings": {}
    }
  ],
  "eligible_participant_count": 42
}

Create a filter set from a list of filters

Authentication

AuthorizationToken

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.

workspace_idstringOptional

ID of the workspace where the filter set can be used.

organisation_idstringOptional

ID of the organisation where the filter set can be used.

namestringOptional

Name of the filter set.

filterslist of objectsOptional

List of all filters contained in the filter set.

Response

Filter set created

idstring

ID of the filter set.

versioninteger

An incrementing integer indicating the version of the filter set.

is_deletedboolean

Whether the filter set has been deleted.

is_lockedboolean

Whether the filter set has been locked.

workspace_idstring or null

ID of the workspace where the filter set can be used.

organisation_idstring or null

ID of the workspace where the filter set can be used.

namestring

Name of the filter set.

filterslist of objects

List of all filters contained in the filter set.

eligible_participant_countinteger

The number of participants who match the filter sets filters. Please note that if the number is lower than 25 the count will be obscured to prevent identification of participants.

Errors

4XX

Client Request Error