Kaizen
Browse modulesInsightsinsights/sharedInterfaces

Interface: MetricResult

Defined in: shared/insights/types/results.ts:73

The result of running a metric. value is the scalar aggregate (a string for decimal money — see ReportCellValue). series is populated when the metric run requested a time bucket.

Properties

format?

optional format?: {
  money?: {
     currencyCode?: string;
     representation: "decimal" | "minorUnits";
     scale: number;
  };
  type: "string" | "number" | "boolean" | "date" | "enum" | "datetime" | "money";
};

Defined in: shared/insights/types/results.ts:77

money?

optional money?: {
  currencyCode?: string;
  representation: "decimal" | "minorUnits";
  scale: number;
};
money.currencyCode?
optional currencyCode?: string;
money.representation
representation: "decimal" | "minorUnits" = moneyRepresentationSchema;
money.scale
scale: number;

type

type: "string" | "number" | "boolean" | "date" | "enum" | "datetime" | "money" = semanticFieldTypeSchema;

key

key: string;

Defined in: shared/insights/types/results.ts:74


label

label: string;

Defined in: shared/insights/types/results.ts:75


series?

optional series?: MetricSeriesPoint[];

Defined in: shared/insights/types/results.ts:78


value

value: ReportCellValue;

Defined in: shared/insights/types/results.ts:76

On this page