الحصول على تحليلات التفاعلات

المعلمات

المسار

الاسم	النوع	مطلوب	الوصف
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 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	اختياري	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.

يعيد تحليلات التقييمات لموقع واحد. يعيد هذا المسار مؤشرات الأداء الرئيسية للنظرة العامة؛ ويعيد مساران آخران الأشكال الأخرى للتحليلات، ولكل منهما صفحة خاصة به:

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 لحساب جديد ليست له فترة سابقة).

حالة استخدام: بطاقة مؤشرات أداء لموقع

لعرض بطاقة «لمحة عن التقييمات» في لوحة التحكم الخاصة بمتجر، استدعِ نقطة النهاية هذه باستخدام معرّف الموقع فقط، إذ لا يلزم نطاق تواريخ للنظرة العامة. اقرأ overall-rating لعرض متوسط النجوم الرئيسي وreview-response-rate لإظهار عدد التقييمات التي ردّ عليها الفريق. استخدمها مع review-analytics-timeline (مع تمرير startDate/endDate) عندما تحتاج البطاقة إلى مخطط خطي مصغّر يوضح الاتجاه على مدى 30 يومًا.

يقبل locationId إما معرّف قاعدة البيانات الرقمي الخام أو معرّف Relay المرمّز بصيغة Base64 بالتبادل، لذا يمكنك إعادة استخدام المعرّف نفسه الذي حصلت عليه من سرد جميع المواقع.