האובייקט Report Snapshot

מאפיינים

• facility_id string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

  המזהה הייחודי של המתקן מ-Performance Hub.

• linking_identifier string אחד מהשנייםספקו את סוג מזהה המתקן שהוגדר לאינטגרציה שלכם: השתמשו ב-facility_id לאינטגרציות מסוג direct-link, או ב-linking_identifier לאינטגרציות מסוג linking-identifier. אל תשלחו את שניהם; ה-API משתמש בסוג המזהה שהוגדר לחשבון השותף שלכם ומתעלם מהסוג האחר. מידע נוסף

  ערך המזהה הייחודי שהשותף משתמש בו לכל מיקום (לדוגמה, "Branch ID", "Location Code", "Store Number"). מידע נוסף

• start_date string חובה

  תאריך ההתחלה של תקופת תמונת המצב בפורמט YYYY-MM-DD.

• end_date string חובה

  תאריך הסיום של תקופת תמונת המצב בפורמט YYYY-MM-DD.

• metrics object חובה

  אובייקט מדדים שמכיל נתוני חברים והכנסות לתקופה.

האובייקט Report Snapshot

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