Search filter choices by keyword

GET

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

GET

/api/v1/filters/:filter_id/choices/search/

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

{
  "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
        }
      ]
    }
  ],
  "meta": {
    "count": 4
  },
  "_links": {
    "self": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/search/?q=developers&limit=2&offset=0",
      "title": "Current"
    },
    "next": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/search/?q=developers&limit=2&offset=2",
      "title": "Next"
    },
    "previous": {
      "href": null,
      "title": "Previous"
    },
    "last": {
      "href": "https://api.prolific.com/api/v1/filters/job-title/choices/search/?q=developers&limit=2&offset=2",
      "title": "Last"
    }
  }
}

Search choice labels only, rank the complete matching collection, then paginate. Uses the same matching and ordering as global previews: the first three equivalent results equal the global preview. Ranking is conveyed only by array order. Workspace permissions apply before searching or counting. Self, next and previous links preserve the query and workspace context, including workspace_id. Pagination links follow shared API conventions. Empty results retain the same envelope.

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

Path parameters

filter_idstringRequired

ID of a filter available in the resolved, permitted catalogue.

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 filter choices by keyword

resultslist of objects

metaobject

_linksobject

Errors

400

Bad Request Error

4XX

Client Request Error

403

Forbidden Error

404

Not Found Error