Dapatkan analitik interaksi

Parameter

Path

Nama	Tipe	Wajib	Deskripsi
locationId	string	wajib	Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

Query

Nama	Tipe	Wajib	Deskripsi	Default
startDate	string	opsional	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	opsional	End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.	—

Respons

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.

Mengembalikan analitik ulasan untuk satu lokasi. Rute ini mengembalikan ringkasan KPI; dua rute terkait mengembalikan bentuk analitik lainnya, masing-masing dengan halaman tersendiri:

review-analytics-overview (halaman ini): statistik keseluruhan: total-reviews, new-reviews, overall-rating (rata-rata, 1–5), dan review-response-rate (persentase). Kunci respons: interactionsAnalyticsStats.
review-analytics-timeline: deret waktu harian jumlah interaksi dan nilai rata-rata untuk suatu rentang tanggal. Kunci respons: interactionsChartData. Memerlukan startDate dan endDate.
review-analytics-sites-stats: perincian per platform yang menampilkan nilai rata-rata, total interaksi, dan aktivitas terkini untuk setiap situs sumber. Kunci respons: interactionsSitesStats.

Setiap entri dalam stats memuat name, value, dan delta. delta adalah persentase perubahan relatif terhadap periode sebelumnya dengan durasi yang sama (akun baru yang belum memiliki periode sebelumnya melaporkan 100).

Contoh penggunaan: kartu ringkasan penilaian lokasi

Untuk menampilkan kartu "sekilas ulasan" pada dasbor toko, panggil endpoint ini hanya dengan ID lokasi; ringkasan ini tidak memerlukan rentang tanggal. Baca overall-rating untuk nilai rata-rata bintang utama dan review-response-rate untuk menampilkan jumlah ulasan yang telah dibalas oleh tim. Padukan dengan review-analytics-timeline (dengan meneruskan startDate/endDate) saat kartu memerlukan grafik mini tren 30 hari.

locationId menerima ID numerik mentah dari basis data maupun ID Relay Base64 yang dapat digunakan secara bergantian, sehingga Anda dapat menggunakan kembali ID yang Anda terima dari Cantumkan semua lokasi.