Объект Report Snapshot

Атрибуты

• 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 обязательный

  Объект показателей с данными об участниках и выручке за период.

Объект 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"
    }
  }
}