GET/api/v4/locations/{locationId}/facebook-analytics

الحصول على تحليلات Facebook لموقع

يُرجع مقاييس التفاعل اليومية مع صفحة Facebook الخاصة بموقع خلال نطاق زمني.

يتطلب مفتاح API. راجع المصادقة لمعرفة تنسيق الترويسة وتدوير المفاتيح.

المعلمات

المسار

الاسمالنوعمطلوبالوصف
locationIdstringمطلوبLocation ID, either the Base64 Relay id (e.g. TG9jYXRpb246MTgwMDI4OQ==) or the raw numeric database id (e.g. 1800289). Both forms resolve to the same location.

الاستعلام

الاسمالنوعمطلوبالوصفالافتراضي
fromDatestringاختياريStart of the range (YYYY-MM-DD). Defaults to a recent window when omitted.—
toDatestringاختياريEnd of the range (YYYY-MM-DD).—

الاستجابات

200Daily Facebook Page interaction metrics. Each metric is a time-series array; a metric is `null` when no data exists for the range or the Page is not connected.
Response
{  "data": {    "facebookInsights": {      "views": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 120 }      ],      "ctaAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 5 }      ],      "directionsAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 3 }      ],      "phoneAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 2 }      ],      "websiteAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 9 }      ]    }  }}
401Unauthenticated, missing or invalid API key.

يُرجع بيانات التفاعل اليومية مع صفحة Facebook الخاصة بموقع. كل مقياس عبارة عن مصفوفة من نقاط سلسلة زمنية، تحتوي كل نقطة على startTime (اليوم الذي جُمّعت له البيانات) وvalue. يتطلب ذلك ربط صفحة Facebook الخاصة بالموقع.

المقاييس المتاحة:

  • views: إجمالي مشاهدات الصفحة
  • ctaAction: النقرات على زر الدعوة إلى اتخاذ إجراء في الصفحة
  • directionsAction: طلبات الاتجاهات عبر الصفحة
  • phoneAction: المكالمات التي بُدئت من الصفحة
  • websiteAction: النقرات للانتقال إلى الموقع الإلكتروني من الصفحة

يمكن استخدام أيٍّ من صيغتي id في المسار

كما هو الحال مع نقاط نهاية التحليلات الأخرى، يقبل facebook-analytics معرّف Relay بترميز Base64 (TG9jYXRpb246MTgwMDI4OQ==) أو المعرّف الرقمي الخام (1800289)، ويشير كلاهما إلى الموقع نفسه. يُفضّل استخدام معرّف Relay، وهو ما تُرجعه نقاط نهاية القراءة. يؤدي استخدام قيمة لا تطابق أيًّا من الصيغتين إلى إرجاع {"data":{"facebookInsights":null},"errors":[...]} مع رمز الحالة 200.

Shell
curl -s 'https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/facebook-analytics?fromDate=2025-06-01&toDate=2025-06-30' \  -H "Authorization: API $LISTINGSAPI_KEY"

إسناد التفاعل إلى زر الدعوة إلى اتخاذ إجراء

عندما يستخدم موقع دعوة إلى اتخاذ إجراء مثل "احجز الآن" أو "اتصل الآن" على صفحته، يتيح لك ctaAction وphoneAction قياس عدد تلك النقرات التي نتجت عن الزر خلال فترة الحملة. لاحظ أن كل مقياس يُرجع null (وليس مصفوفة فارغة) عندما لا تتوفر بيانات للصفحة ضمن النطاق الزمني أو عندما تكون الصفحة غير مربوطة؛ لذا تحقّق من null قبل المرور على العناصر. ادمج هذه البيانات مع تحليلات Google وBing لإنشاء عرض موحّد للأداء عبر منصات نشر متعددة.

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