Search filters by keyword

GET

https://api.prolific.com/api/v1/filters/search/

GET

/api/v1/filters/search/

curl -G https://api.prolific.com/api/v1/filters/search/ \
     -H "Authorization: Token <token>" \
     -d q=q

{
  "results": [
    {
      "filter_id": "job-title",
      "title": "Job title",
      "description": "Select participants by occupation.",
      "question": "What is your job title?",
      "category": "Employment",
      "subcategory": null,
      "type": "select",
      "data_type": "ChoiceID",
      "matches": [],
      "choices_included": true,
      "choices": {
        "total": 5,
        "matched": 4,
        "truncated": true,
        "results": [
          {
            "id": "100",
            "label": "Software developers",
            "parent_id": null,
            "num_children": 3,
            "num_descendants": 3,
            "matches": [
              {
                "field": "label",
                "query_term": "developers",
                "matched_text": "developers",
                "start": 9,
                "end": 19
              }
            ]
          },
          {
            "id": "101",
            "label": "Application software developer",
            "parent_id": "100",
            "num_children": 0,
            "num_descendants": 0,
            "matches": [
              {
                "field": "label",
                "query_term": "developers",
                "matched_text": "developer",
                "start": 21,
                "end": 30
              }
            ]
          },
          {
            "id": "102",
            "label": "Systems software developer",
            "parent_id": "100",
            "num_children": 0,
            "num_descendants": 0,
            "matches": [
              {
                "field": "label",
                "query_term": "developers",
                "matched_text": "developer",
                "start": 17,
                "end": 26
              }
            ]
          }
        ]
      },
      "available_verification_dimensions": [
        "corroborated"
      ],
      "_links": {
        "choices": {
          "href": "https://api.prolific.com/api/v1/filters/job-title/choices/?limit=25&offset=0",
          "title": "Choices"
        },
        "matching_choices": {
          "href": "https://api.prolific.com/api/v1/filters/job-title/choices/search/?q=developers&limit=25&offset=0",
          "title": "Matching choices"
        }
      }
    }
  ],
  "meta": {
    "count": 1
  },
  "_links": {
    "self": {
      "href": "https://api.prolific.com/api/v1/filters/search/?q=developers",
      "title": "Current"
    },
    "next": {
      "href": null,
      "title": "Next"
    },
    "previous": {
      "href": null,
      "title": "Previous"
    },
    "last": {
      "href": "https://api.prolific.com/api/v1/filters/search/",
      "title": "Last"
    }
  }
}

Search titles, questions, descriptions, researcher help text, categories, subcategories, filter IDs and choice labels. Supports stemming, prefixes and accent-insensitive matching. Returns matching filters in ranked order with at most three matching choices per filter. Results are always paginated, with limit defaulting to 25 and offset to zero. meta.count always counts all matching filters before pagination. Workspace permissions apply before searching or counting. Study and participant-group filters remain searchable by metadata, but their choices are not loaded or searched. Their results have choices_included false and a link to browse choices separately. Available verification dimensions are returned when present in the filter catalogue, but are not searched. Self, next and previous links preserve the query and workspace context, including workspace_id. Ranking is conveyed only by array order. Pagination links follow shared API conventions; offsets beyond the matches return an empty page.

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>.

Query parameters

qstringRequired1-200 characters

Trimmed, nonblank keyword query, at most 200 characters after trimming. Text is not a query language. Nonblank input with no searchable characters returns no matches.

limitintegerOptional>=1Defaults to 25

Page size. Pagination applies even when this parameter is omitted.

offsetintegerOptional>=0Defaults to 0

Zero-based result offset. An offset beyond the collection returns an empty page.

workspace_idstringOptional

Workspace used to resolve accessible filters.

Response

Search filters by keyword

resultslist of objects

metaobject

_linksobject

Errors

400

Bad Request Error

4XX

Client Request Error

403

Forbidden Error

404

Not Found Error