L'objet Report Snapshot
Attributs
-
facility_id
stringl'un ou l'autreIndiquez le type d'identifiant d'installation configuré pour votre intégration : utilisez facility_id pour les intégrations à liaison directe, ou linking_identifier pour les intégrations à identifiant de liaison. N'envoyez pas les deux ; l'API utilise le type d'identifiant configuré pour votre compte partenaire et ignore l'autre. En savoir plusIdentifiant unique de l'installation dans Performance Hub.
-
linking_identifier
stringl'un ou l'autreIndiquez le type d'identifiant d'installation configuré pour votre intégration : utilisez facility_id pour les intégrations à liaison directe, ou linking_identifier pour les intégrations à identifiant de liaison. N'envoyez pas les deux ; l'API utilise le type d'identifiant configuré pour votre compte partenaire et ignore l'autre. En savoir plusValeur d'identifiant unique que le partenaire utilise pour chaque site (par exemple, « Branch ID », « Location Code », « Store Number »). En savoir plus
-
start_date
stringobligatoireDate de début de la période de l'instantané au format
YYYY-MM-DD. -
end_date
stringobligatoireDate de fin de la période de l'instantané au format
YYYY-MM-DD. -
metrics
objectobligatoireObjet d'indicateurs contenant les données sur les membres et le chiffre d'affaires pour la période.
L'objet 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"
}
}
}