api-popularword.rst

人気ワードAPI

人気ワード一覧の取得

|Fess| に、 http://<Server Name>/json/?type=popularword のリクエストを送ることで、|Fess| の検索結果をJSON形式で受け取ることができます。 人気ワードAPIを利用するには、管理画面のシステム 全般の設定で人気ワードのレスポンスを有効にしておく必要があります。

リクエストパラメータ

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

.. tabularcolumns:: |p{3cm}|p{12cm}|

リクエストパラメータ

seed	人気ワードを取得するシード(この値により異なるパターンの単語を取得可能です)

レスポンス

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

{
    "response":{
        "version":13.2,
        "status":0,
        "result":[
             "\u65E5\u672C\u8A9E",
             ".pdf",
             "\u66F4\u65B0\u65E5",
             "\u691C\u7D22\u7D50\u679C",
             "google",
             "pdf",
             "excel",
             "solr",
             "fess",
             "\u30D5\u30A1\u30A4\u30EB"
        ]
    }
}

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

.. tabularcolumns:: |p{3cm}|p{12cm}|

レスポンス情報

response	ルート要素
version	フォーマットバージョン
status	レスポンスのステータス(status値は、0:正常、1:検索エラー、2または3:リクエストパラメータエラー、9:サービス停止中、-1:API種別エラーです)
result	人気ワード