O objeto Report Snapshot

Atributos

• facility_id string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Identificador exclusivo da instalação no Performance Hub.

• linking_identifier string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Valor do identificador exclusivo que o parceiro usa para cada local (por exemplo, "Branch ID", "Location Code", "Store Number"). Saiba mais

• start_date string obrigatório

  Data de início do período do snapshot no formato YYYY-MM-DD.

• end_date string obrigatório

  Data de término do período do snapshot no formato YYYY-MM-DD.

• metrics object obrigatório

  Objeto de métricas que contém os dados de membros e de receita do período.

O objeto 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"
    }
  }
}