Skip to main content

AnalyticsSettings

The analytics settings of the tenant.

type AnalyticsSettings {
  budgetUsageGreenFrom: BigDecimal!
  budgetUsageYellowFrom: BigDecimal!
  bwaLines: [BwaLine!]!
  groupSettings: [GroupPlanSetting!]!
  id: ID!
  revenuePlan: RevenuePlanParameters!
  staffingPlan: StaffingPlanParameters!
  version: Int
}

Fields​

AnalyticsSettings.budgetUsageGreenFrom ● BigDecimal! non-null scalar​

The budget usage in percent from which a cell turns green: the target is reached. Always above budgetUsageYellowFrom. Default 110.

AnalyticsSettings.budgetUsageYellowFrom ● BigDecimal! non-null scalar​

The budget usage in percent from which a cell turns yellow. Below it the cell is red. Default 100.

AnalyticsSettings.bwaLines ● [BwaLine!]! non-null object​

The BWA lines of the tenant in the order they are shown, with their rules. Seven preset lines, one per planning formula, while nothing is stored.

AnalyticsSettings.groupSettings ● [GroupPlanSetting!]! non-null object​

How each apartment group is planned, by apartment label. A label without an entry is not planned. Empty while nothing is stored.

AnalyticsSettings.id ● ID! non-null scalar​

Identifies the one settings document of the tenant, so the client cache replaces it on a write.

AnalyticsSettings.revenuePlan ● RevenuePlanParameters! non-null object​

The tenant-wide parameters of the revenue plan. Defaults while nothing is stored.

AnalyticsSettings.staffingPlan ● StaffingPlanParameters! non-null object​

The tenant-wide parameters of the staffing plan with the staffing of each apartment group. Defaults while nothing is stored.

AnalyticsSettings.version ● Int scalar​

The version of the stored settings, to send back as expectedVersion of updateAnalyticsSettings. Null while nothing is stored.

Returned By​

analyticsSettings query

Member Of​

UpdateAnalyticsSettingsPayload object