Het Report Snapshot-object

Attributen

  • facility_id string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

    Unieke identificatie van de faciliteit uit Performance Hub.

  • linking_identifier string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

    Unieke identificatiewaarde die de partner voor elke locatie gebruikt (bijvoorbeeld "Branch ID", "Location Code", "Store Number"). Meer informatie

  • start_date string verplicht

    Begindatum van de periode van de momentopname in de notatie YYYY-MM-DD.

  • end_date string verplicht

    Einddatum van de periode van de momentopname in de notatie YYYY-MM-DD.

  • metrics object verplicht

    Metrics-object met gegevens over leden en omzet voor de periode.

Het Report Snapshot-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"
    }
  }
}