Das Berichts-Snapshot-Objekt

Attribute

• facility_id string entweder/oderGeben Sie den für Ihre Integration konfigurierten Typ der Einrichtungskennung an: Verwenden Sie facility_id für Direct-Link-Integrationen oder linking_identifier für Linking-Identifier-Integrationen. Senden Sie nicht beide; die API verwendet den für Ihr Partnerkonto konfigurierten Kennungstyp und ignoriert den anderen. Weitere Informationen

  Eindeutige Kennung der Einrichtung aus dem Performance Hub.

• linking_identifier string entweder/oderGeben Sie den für Ihre Integration konfigurierten Typ der Einrichtungskennung an: Verwenden Sie facility_id für Direct-Link-Integrationen oder linking_identifier für Linking-Identifier-Integrationen. Senden Sie nicht beide; die API verwendet den für Ihr Partnerkonto konfigurierten Kennungstyp und ignoriert den anderen. Weitere Informationen

  Eindeutiger Kennungswert, den der Partner für jeden Standort verwendet (z. B. „Branch ID“, „Location Code“, „Store Number“). Weitere Informationen

• start_date string erforderlich

  Startdatum des Snapshot-Zeitraums im Format YYYY-MM-DD.

• end_date string erforderlich

  Enddatum des Snapshot-Zeitraums im Format YYYY-MM-DD.

• metrics object erforderlich

  Kennzahlenobjekt mit Mitglieder- und Umsatzdaten für den Zeitraum.

Das Berichts-Snapshot-Objekt

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