报告快照对象

属性

  • facility_id string 二选一请提供为您的集成配置的设施标识符类型:直接关联集成使用 facility_id,关联标识符集成使用 linking_identifier。请勿同时发送两者;API 会使用为您的合作伙伴账户配置的标识符类型,并忽略另一个。了解详情

    Performance Hub 中设施的唯一标识符。

  • linking_identifier string 二选一请提供为您的集成配置的设施标识符类型:直接关联集成使用 facility_id,关联标识符集成使用 linking_identifier。请勿同时发送两者;API 会使用为您的合作伙伴账户配置的标识符类型,并忽略另一个。了解详情

    合作伙伴为每个位置使用的唯一标识符值(例如“Branch ID”“Location Code”“Store Number”)。了解详情

  • start_date string 必填

    YYYY-MM-DD 格式的快照期间开始日期。

  • end_date string 必填

    YYYY-MM-DD 格式的快照期间结束日期。

  • metrics object 必填

    包含该期间会员和收入数据的指标对象。

报告快照对象

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