OBJECT

DashboardKpiData

Computed values of a dashboard KPI for the current and comparison periods, with its chart data.

link GraphQL Schema definition

  • type DashboardKpiData implements DashboardChartId {
  • # Id of the chart the data belongs to on a record compact view; null for dashboard
  • # items, which are returned in the order of the dashboard items.
  • id: String
  • # Reason the item has no data; null when the data loaded.
  • error: DashboardChartError
  • # Id of the KPI in the dashboard schema.
  • kpiId: UUID
  • # KPI value for the current period.
  • kpiCurrentValue: Float
  • # KPI value for the comparison period; null or 0 when the KPI is not compared.
  • kpiPreviousValue: Float
  • # Values of the KPI over the current period, for its chart; null for a KPI in a
  • # KPI list.
  • kpiChartData: [DashboardChartSeriesValueItem!]
  • # Goal of the KPI target; null for a KPI in a KPI list.
  • kpiChartTarget: Float
  • # For a KPI in a KPI list, the current value minus the comparison value prorated
  • # to the elapsed part of the current period (0 when today is outside it); null for
  • # a standalone KPI.
  • kpiRelativeDifference: Float
  • }

link Require by