L'oggetto Report Snapshot

Attributi

• facility_id string in alternativaIndica il tipo di identificatore della struttura configurato per la tua integrazione: usa facility_id per le integrazioni con collegamento diretto oppure linking_identifier per le integrazioni con identificatore di collegamento. Non inviarli entrambi: l'API usa il tipo di identificatore configurato per il tuo account partner e ignora l'altro. Scopri di più

  Identificatore univoco della struttura nel Performance Hub.

• linking_identifier string in alternativaIndica il tipo di identificatore della struttura configurato per la tua integrazione: usa facility_id per le integrazioni con collegamento diretto oppure linking_identifier per le integrazioni con identificatore di collegamento. Non inviarli entrambi: l'API usa il tipo di identificatore configurato per il tuo account partner e ignora l'altro. Scopri di più

  Valore dell'identificatore univoco che il partner usa per ogni sede (ad esempio "Branch ID", "Location Code", "Store Number"). Scopri di più

• start_date string obbligatorio

  Data di inizio del periodo dell'istantanea nel formato YYYY-MM-DD.

• end_date string obbligatorio

  Data di fine del periodo dell'istantanea nel formato YYYY-MM-DD.

• metrics object obbligatorio

  Oggetto delle metriche, con i dati sui membri e sui ricavi del periodo.

L'oggetto 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"
    }
  }
}