説明

新規/analytics/faq-search/エンドポイントは、エンドユーザー向けのFAQの有効性を監視および評価するため、個々の検索レベルでFAQ検索分析を提供します。

APIエンドポイント

https://analytics.helpshift.com/v1/domain_name/analytics/faq-search/

メトリクス

メトリック名データタイプメトリック定義
total_search_countbigintアプリ内のFAQ内で完了したFAQ検索の数
(結果が表示されたかどうかに関係なく)。
successful_search_countbigintFAQ検索で、表示されたFAQの1つ以上をユーザーがクリックした回数。
no_search_result_countbigint関連するFAQが全く見つからなかったFAQ検索の数。
successful_search_with_no_clicks_countbigintFAQ検索でいくつかのFAQが表示されたが、ユーザーが表示されたFAQを
いずれもクリックしなかった件数。

 

リクエストパラメーター

パラメーター説明
from時間範囲の開始(タイムスタンプ:タイムゾーンなしのISO 8601日時形式)
to時間範囲の終了(タイムスタンプ:タイムゾーンなしのISO 8601日時形式)
aggregationメトリクスの集計レベル(オプション)オプション:workzone_id。Appレベルの権限が有効になっているドメインの場合、ワークゾーンIDで分析レコードをさらにグループ化します。(app_id + language + search_term + date)集計に別のディメンションを追加し、
dataをworkzoneレベルでさらに詳しく説明します。
limit1回の呼び出しで取得するレコード数(オプション)オプション:1〜1000、デフォルトの制限は1000です。

応答形式

モック応答