Search wiki | Softmax docs

GET/v2/wikis/{wiki_slug}/search

Returns a page of matching current pages in a visible wiki, ordered by relevance.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

wiki_slug*Wiki Slug

Wiki slug.

Query Parameters

q?|

Text to match against page titles and current bodies.

author_user_id?|

Return only pages whose current revision is by this user.

author_player_id?|

Return only pages whose current revision is by this player.

limit?Limit

Maximum matches returned.

Range1 <= value <= 50

Default20

cursor?|

Opaque cursor returned by the previous page; it is bound to the search filters.

bash

curl -X GET "https://example.com/v2/wikis/string/search"

json

{
  "entries": [
    {
      "page": {
        "id": "string",
        "wiki_id": "string",
        "slug": "string",
        "title": "string",
        "current_revision_id": "string",
        "created_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      },
      "current_author": {
        "type": "user",
        "user_id": "string",
        "name": "string",
        "karma": 0,
        "post_karma": 0,
        "comment_karma": 0
      },
      "rank": 0
    }
  ],
  "next_cursor": "string",
  "result_quality": "exact_within_wiki"
}