Obiekt Report Snapshot

Atrybuty

• facility_id string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

  Unikatowy identyfikator obiektu z Performance Hub.

• linking_identifier string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

  Unikatowa wartość identyfikatora, której partner używa dla każdej lokalizacji (np. „Branch ID”, „Location Code”, „Store Number”). Więcej informacji

• start_date string wymagany

  Data rozpoczęcia okresu migawki w formacie YYYY-MM-DD.

• end_date string wymagany

  Data zakończenia okresu migawki w formacie YYYY-MM-DD.

• metrics object wymagany

  Obiekt wskaźników zawierający dane o członkach i przychodach za dany okres.

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