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": [
        "ambidextrous"
      ]
    },
    {
      "filter_id": "age",
      "selected_values": [
        "19-22"
      ]
    }
  ]
}'

{
  "eligible_participant_count": 125,
  "filters": [
    {
      "filter_id": "handedness",
      "selected_values": [
        "ambidextrous"
      ],
      "weightings": {}
    },
    {
      "filter_id": "age",
      "selected_values": [
        "19-22"
      ],
      "weightings": {}
    }
  ],
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "is_deleted": false,
  "is_locked": false,
  "name": "Ambidextrous teenagers",
  "organisation_id": "org-9876543210",
  "version": 1,
  "workspace_id": "644aaabfaf6bbc363b9d47c6"
}

Create a filter set from a list of filters

Authentication

AuthorizationToken

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

eligible_participant_countinteger or null

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.

filterslist of objects or null

List of all filters contained in the filter set.

idstring or null

ID of the filter set.

is_deletedboolean or null

Whether the filter set has been deleted.

is_lockedboolean or null

Whether the filter set has been locked.

namestring or null

Name of the filter set.

organisation_idstring or null

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

versioninteger or null

An incrementing integer indicating the version of the filter set.

workspace_idstring or null

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

Authentication

Request

Response

Errors