メニュー

人気ワードAPI

人気ワード一覧の取得

Fess に、 http://<Server Name>/api/v1/popular-words?seed=123 のリクエストを送ることで、Fess に登録されている人気ワードの一覧をJSON形式で受け取ることができます。 人気ワードAPIを利用するには、管理画面のシステム 全般の設定で人気ワードのレスポンスを有効にしておく必要があります。

リクエストパラメーター

使用できるリクエストパラメーターは以下の通りです。

リクエストパラメーター
seed 人気ワードを取得するシード(この値により異なるパターンの単語を取得可能です)
label フィルタされたラベル名
field 人気ワードを生成するフィールド名

レスポンス

以下のようなレスポンスが返ります。

{
  "record_count": 9,
  "data": [
    "python"
  ]
}

各要素については以下の通りです。

レスポンス情報
record_count 人気ワードの登録件数
data 人気ワード