インタラクション分析を取得

パラメーター

パス

名前	型	必須	説明
locationId	string	必須	Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

クエリ

名前	型	必須	説明	デフォルト
startDate	string	任意	Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route.	—
endDate	string	任意	End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.	—

レスポンス

200Overview analytics for the location.

Response

{  "data": {    "interactionsAnalyticsStats": {      "stats": [        { "name": "total-reviews", "value": 128, "delta": 6.67 },        { "name": "new-reviews", "value": 9, "delta": -25 },        { "name": "overall-rating", "value": 4.43, "delta": 2.31 },        { "name": "review-response-rate", "value": 62.5, "delta": 12.5 }      ]    }  }}

401Unauthenticated, missing or invalid API key.

単一の拠点のレビュー分析を返します。このルートは概要のKPIを返し、関連する2つのルートはそれ以外の形式の分析を返します。それぞれに専用のページがあります：

review-analytics-overview（このページ）：全体の統計：total-reviews、new-reviews、overall-rating（平均、1～5）、review-response-rate（パーセンテージ）。レスポンスのキー：interactionsAnalyticsStats。
review-analytics-timeline：指定した日付範囲のインタラクション数と平均評価の日次時系列データ。レスポンスのキー：interactionsChartData。startDateとendDateが必要です。
review-analytics-sites-stats：各ソースサイトの平均評価、インタラクションの総数、最近のアクティビティを示すプラットフォーム別の内訳。レスポンスのキー：interactionsSitesStats。

stats内の各エントリには、name、value、deltaが含まれます。deltaは、直前の同じ長さの期間に対する変化率です（前の期間がない新規アカウントでは100が報告されます）。

ユースケース：拠点のスコアカードタイル

店舗のダッシュボードに「レビューの概要」タイルを表示するには、拠点IDだけを指定してこのエンドポイントを呼び出します。概要には日付範囲の指定は不要です。overall-ratingを読み取って主要指標となる星評価の平均を表示し、review-response-rateを読み取ってチームが返信したレビューの件数を表示します。タイルに30日間の傾向を示すスパークラインが必要な場合は、review-analytics-timelineと組み合わせます（startDate/endDateを渡します）。

locationIdには、生の数値のデータベースIDとBase64 Relay IDのどちらも使用できるため、すべての拠点を一覧表示で取得したIDをそのまま再利用できます。