OBJECT

DashboardKpi

link GraphQL Schema definition

  • type DashboardKpi {
  • # Identifier of the KPI.
  • kpiId: UUID!
  • # Goal definition the KPI value is measured against.
  • kpiTarget: DashboardTargetTab!
  • # Filter conditions limiting which records contribute to the KPI value.
  • kpiFilter: FieldFilter!
  • # Predefined metric the KPI tracks (e.g. OpportunityWon, LeadCreated,
  • # ActivityCompleted); use Custom to define the metric via kpiCustomIndicator.
  • kpiIndicator: DashboardKpiIndicatorEnum!
  • # Custom metric definition applied when kpiIndicator is Custom.
  • kpiCustomIndicator: DashboardKpiCustomDefinition!
  • # When true, the goal is drawn as a target line on the KPI chart.
  • kpiShowTargetLine: Boolean!
  • # Time range the KPI value is calculated over.
  • kpiPeriodCurrent: PeriodOption!
  • # Optional earlier period the current value is compared against to show a trend.
  • kpiPeriodCompare: PeriodCompareOption
  • }