Objek Report Snapshot

Atribut

  • facility_id string salah satuBerikan jenis pengidentifikasi fasilitas yang dikonfigurasi untuk integrasi Anda: gunakan facility_id untuk integrasi direct-link, atau linking_identifier untuk integrasi linking-identifier. Jangan kirim keduanya; API menggunakan jenis pengidentifikasi yang dikonfigurasi untuk akun mitra Anda dan mengabaikan yang lainnya. Pelajari lebih lanjut

    Pengidentifikasi unik fasilitas dari Performance Hub.

  • linking_identifier string salah satuBerikan jenis pengidentifikasi fasilitas yang dikonfigurasi untuk integrasi Anda: gunakan facility_id untuk integrasi direct-link, atau linking_identifier untuk integrasi linking-identifier. Jangan kirim keduanya; API menggunakan jenis pengidentifikasi yang dikonfigurasi untuk akun mitra Anda dan mengabaikan yang lainnya. Pelajari lebih lanjut

    Nilai pengidentifikasi unik untuk setiap lokasi yang digunakan mitra (misalnya, "Branch ID", "Location Code", "Store Number"). Pelajari lebih lanjut

  • start_date string wajib

    Tanggal mulai periode snapshot dalam format YYYY-MM-DD.

  • end_date string wajib

    Tanggal akhir periode snapshot dalam format YYYY-MM-DD.

  • metrics object wajib

    Objek metrik yang berisi data anggota dan pendapatan untuk periode tersebut.

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