Đối tượng Report Snapshot

Thuộc tính

• facility_id string một trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêm

  Mã định danh duy nhất của cơ sở trong Performance Hub.

• linking_identifier string một trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêm

  Giá trị mã định danh duy nhất mà đối tác dùng cho từng địa điểm (ví dụ: "Branch ID", "Location Code", "Store Number"). Tìm hiểu thêm

• start_date string bắt buộc

  Ngày bắt đầu kỳ của ảnh chụp nhanh theo định dạng YYYY-MM-DD.

• end_date string bắt buộc

  Ngày kết thúc kỳ của ảnh chụp nhanh theo định dạng YYYY-MM-DD.

• metrics object bắt buộc

  Đối tượng chỉ số chứa dữ liệu hội viên và doanh thu trong kỳ.

Đối tượng 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"
    }
  }
}