Report Snapshot nesnesi

Öznitelikler

  • facility_id string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    Performance Hub'daki tesisin benzersiz tanımlayıcısı.

  • linking_identifier string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    İş ortağının her konum için kullandığı benzersiz tanımlayıcı değeri (ör. "Branch ID", "Location Code", "Store Number"). Daha fazla bilgi

  • start_date string zorunlu

    YYYY-MM-DD biçiminde anlık görüntü dönemi başlangıç tarihi.

  • end_date string zorunlu

    YYYY-MM-DD biçiminde anlık görüntü dönemi bitiş tarihi.

  • metrics object zorunlu

    Dönemin üye ve gelir verilerini içeren ölçümler nesnesi.

Report Snapshot nesnesi

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