GET/api/v4/locations/{locationId}/review-analytics-overview

获取互动分析

返回某个地点的评价分析概览(KPI)。另外 2 个同级路由分别返回时间序列和按站点细分的数据。

需要 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;另外 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。

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