/api/v4/locations/{locationId}/review-analytics-overviewEtkileşim analitiğini alın
Bir konum için genel yorum analitiğini (KPI'lar) döndürür. İki eş düzey rota, bir zaman serisi ve site bazında bir döküm döndürür.
Parametreler
Yol
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| locationId | string | zorunlu | Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). |
Sorgu
| Ad | Tür | Zorunlu | Açıklama | Varsayılan |
|---|---|---|---|---|
| startDate | string | isteğe bağlı | 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 | isteğe bağlı | End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route. | — |
Yanıtlar
200Overview analytics for the location.
{ "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.
Tek bir konum için yorum analitiğini döndürür. Bu rota genel KPI'ları döndürür; her biri kendi sayfasında açıklanan iki eş düzey rota ise diğer analitik biçimlerini döndürür:
review-analytics-overview(bu sayfa): genel istatistikler:total-reviews,new-reviews,overall-rating(ortalama, 1–5) vereview-response-rate(yüzde). Yanıt anahtarı:interactionsAnalyticsStats.review-analytics-timeline: bir tarih aralığı için etkileşim sayısının ve ortalama puanın günlük zaman serisi. Yanıt anahtarı:interactionsChartData.startDateveendDategerektirir.review-analytics-sites-stats: her kaynak site için ortalama puanı, toplam etkileşim sayısını ve son etkinlikleri gösteren platform bazında döküm. Yanıt anahtarı:interactionsSitesStats.
stats içindeki her öğe bir name, bir value ve bir delta içerir. delta, önceki eşdeğer döneme göre yüzde değişimidir (önceki dönemi bulunmayan yeni bir hesap için 100 bildirilir).
Kullanım senaryosu: konum performans kartı
Bir mağazanın kontrol panelinde "bir bakışta yorumlar" kartını görüntülemek için bu uç noktayı yalnızca konum kimliğiyle çağırın; genel bakış için tarih aralığı gerekmez. Öne çıkan yıldız ortalaması için overall-rating değerini, ekibin kaç yoruma yanıt verdiğini göstermek için ise review-response-rate değerini okuyun. Kartta 30 günlük eğilimi gösteren küçük bir çizgi grafiği gerektiğinde bunu review-analytics-timeline ile birlikte kullanın (startDate/endDate parametrelerini ileterek).
locationId, ham sayısal veritabanı kimliğini veya Base64 Relay kimliğini birbirinin yerine kabul eder; böylece Tüm konumları listeleyin çağrısından aldığınız kimliği yeniden kullanabilirsiniz.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \ -H "Authorization: API $LISTINGSAPI_KEY"