GET
/api/v4/locations/{locationId}/review-analytics-sites-statsサイト別のレビュー分析を取得
1つの拠点について、レビュー件数、評価、最新レビューの時期の内訳をソース別に返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 comparison period (`YYYY-MM-DD`). The `delta` fields compare this period against the previous equivalent one. | — |
| endDate | string | 任意 | End of the comparison period (`YYYY-MM-DD`). | — |
レスポンス
200One entry per review source configured for the location. Response key `interactionsSitesStats`.
{ "data": { "interactionsSitesStats": { "stats": [ { "key": "google", "siteUrl": "maps.google.com", "averageRating": { "value": 4.6, "delta": 2.2 }, "totalInteractions": { "value": 412, "delta": 6.1 }, "newInteractions": { "value": 24, "delta": 33.3 }, "recency": "2026-09-06T14:12:00Z", "baseRating": 4.5, "baseInteractions": 388, "humanizedRecency": "3 days ago" }, { "key": "facebook", "siteUrl": "facebook.com", "averageRating": { "value": 4.1, "delta": -1.4 }, "totalInteractions": { "value": 57, "delta": 0 }, "newInteractions": { "value": 0, "delta": -100 }, "recency": null, "baseRating": 4.16, "baseInteractions": 57, "humanizedRecency": null } ] } }}401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to read this location (`SY90003`).
拠点のレビュー実績をソース別に分けて、どのプラットフォームが変化の要因になっているかを確認できるようにします。これは、インタラクション分析を取得(全体のKPI)およびレビュー分析のタイムラインを取得(日次の時系列データ)のサイト別版です。
stats内の各エントリは、1つのレビューソースを表します。
key/siteUrl: ソースの短いキーと、そのサイトのURLです。siteUrlは、拠点のレビューソースの一覧を取得のsiteSettings[].nameと一致します。averageRating、totalInteractions、newInteractions: それぞれ、リクエストした期間のvalueと、直前の同じ長さの期間に対する変化率(パーセント)であるdeltaを含むオブジェクトです。baseRating/baseInteractions: 期間の開始時点における対応する値で、deltaを算出する際の基準となります。recency: そのソースの最新レビューのタイムスタンプで、ソースがレビューを一度も返したことがない場合はnullです。humanizedRecency: 同じ時点を表示用に整形したものです(「3日前」)。
ユースケース:平均値を変動させたプラットフォームの特定
拠点の総合評価が下がったとき、このルートでどこに変化があったかを確認できます。ソースごとのaverageRating.deltaを確認します。他のソースが横ばいで、1つだけ突出してマイナスになっている場合は、そのプラットフォームに要因があることを示し、全般的にマイナスになっている場合は、店舗に要因があることを示します。recencyが数か月前のソースでnewInteractions.valueが0になっている場合、通常は顧客がレビューを投稿しなくなったのではなく、接続が更新されなくなったことを意味するため、拠点のレビューソースの一覧を取得と照合してください。
上記のレスポンスは一例です。
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-sites-stats' \ -H "Authorization: API $LISTINGSAPI_KEY"