रिपोर्ट स्नैपशॉट ऑब्जेक्ट

एट्रिब्यूट

  • 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"
    }
  }
}