This is a cache of https://fess.codelibs.org/ja/15.3/api/api-popularword.html. It is a snapshot of the page at 2025-11-07T00:16:42.733+0000.
人気ワードAPI

メニュー

人気ワードAPI

人気ワード一覧の取得

リクエスト

HTTPメソッド GET
エンドポイント /api/v1/popular-words

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

リクエストパラメーター

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

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

レスポンス

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

{
  "record_count": 3,
  "data": [
    "python",
    "java",
    "javascript"
  ]
}

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

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

エラーレスポンス

人気ワードAPIが失敗した場合、以下のようなエラーレスポンスが返されます。

エラーレスポンス
ステータスコード 説明
400 Bad Request リクエストパラメーターが不正な場合
500 Internal Server Error サーバー内部エラーが発生した場合