كائن لقطة التقرير

السمات

• facility_id string أحدهماقدّم نوع معرّف المنشأة المهيّأ لتكاملك: استخدم facility_id لتكاملات الربط المباشر، أو linking_identifier لتكاملات معرّف الربط. لا ترسل كليهما؛ إذ تستخدم API نوع المعرّف المهيّأ لحساب الشريك الخاص بك وتتجاهل الآخر. اعرف المزيد

  المعرّف الفريد للمنشأة من Performance Hub.

• linking_identifier string أحدهماقدّم نوع معرّف المنشأة المهيّأ لتكاملك: استخدم facility_id لتكاملات الربط المباشر، أو linking_identifier لتكاملات معرّف الربط. لا ترسل كليهما؛ إذ تستخدم API نوع المعرّف المهيّأ لحساب الشريك الخاص بك وتتجاهل الآخر. اعرف المزيد

  قيمة المعرّف الفريد لكل موقع يستخدمها الشريك (مثل "Branch ID" و"Location Code" و"Store Number"). اعرف المزيد

• start_date string مطلوب

  تاريخ بداية فترة اللقطة بتنسيق YYYY-MM-DD.

• end_date string مطلوب

  تاريخ نهاية فترة اللقطة بتنسيق YYYY-MM-DD.

• metrics object مطلوب

  كائن المقاييس الذي يحتوي على بيانات الأعضاء والإيرادات للفترة.

كائن لقطة التقرير

{
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  // "linking_identifier": "branch_downtown",  // If using linking identifier
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "metrics": {
    "members": {
      "active": 1200,
      "new": 45,
      "cancelled": 12
    },
    "revenue": {
      "total_payments": 289000.00,
      "total_payments_count": 1200,
      "currency": "AUD"
    }
  }
}