Listings APIListings API
登入
GET/api/v4/locations/{locationId}/review-analytics-overview

取得互動分析

傳回某個地點的評論分析總覽（KPI）。另有兩個相關路由，分別傳回時間序列和依網站細分的資料。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

路徑

名稱類型必填說明
locationIdstring必填Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

查詢

名稱類型必填說明預設值
startDatestring選填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.—
endDatestring選填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；另有兩個相關路由傳回其他形式的分析資料，且各有專屬頁面：

  • 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。

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \  -H "Authorization: API $LISTINGSAPI_KEY"
Run in playground