Objek Petikan Laporan

Atribut

  • facility_id string salah satuBerikan jenis pengecam kemudahan yang dikonfigurasikan untuk integrasi anda: gunakan facility_id untuk integrasi Direct Link, atau linking_identifier untuk integrasi Linking Identifier. Jangan hantar kedua-duanya; API menggunakan jenis pengecam yang dikonfigurasikan untuk akaun rakan kongsi anda dan mengabaikan yang satu lagi. Ketahui lebih lanjut

    Pengecam unik kemudahan daripada Performance Hub.

  • linking_identifier string salah satuBerikan jenis pengecam kemudahan yang dikonfigurasikan untuk integrasi anda: gunakan facility_id untuk integrasi Direct Link, atau linking_identifier untuk integrasi Linking Identifier. Jangan hantar kedua-duanya; API menggunakan jenis pengecam yang dikonfigurasikan untuk akaun rakan kongsi anda dan mengabaikan yang satu lagi. Ketahui lebih lanjut

    Nilai pengecam unik untuk setiap lokasi yang digunakan oleh rakan kongsi (contohnya, "Branch ID", "Location Code", "Store Number"). Ketahui lebih lanjut

  • start_date string wajib

    Tarikh mula tempoh petikan dalam format YYYY-MM-DD.

  • end_date string wajib

    Tarikh tamat tempoh petikan dalam format YYYY-MM-DD.

  • metrics object wajib

    Objek metrik yang mengandungi data ahli dan hasil bagi tempoh tersebut.

Objek Petikan Laporan

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