v1.Metric
export interface Metric
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) An optional description of the metric. | ||
string | (Optional) Metric value default format | ||
boolean | (Optional) | ||
string | Define MAQL syntax for metric. | ||
boolean | (Optional) Optional flag to indicate if the metric should be shown in AI results. When omitted, the metric is visible. | ||
(Optional) | |||
string | (Optional) An optional human readable title for the metric. Will be derived from id if not provided explicitly. | ||
“metric” |
Property details
v1.Metric.descriptionproperty
An optional description of the metric.
description?: string;
v1.Metric.formatproperty
Metric value default format
format?: string;
v1.Metric.idproperty
id: Id7;
v1.Metric.is_hiddenpropertyDeprecated
Warning: This API is now obsolete.
Deprecated. Use ‘show_in_ai_results’ instead.
is_hidden?: boolean;
v1.Metric.maqlproperty
Define MAQL syntax for metric.
maql: string;
v1.Metric.show_in_ai_resultsproperty
Optional flag to indicate if the metric should be shown in AI results. When omitted, the metric is visible.
show_in_ai_results?: boolean;
v1.Metric.tagsproperty
tags?: Tags8;
v1.Metric.titleproperty
An optional human readable title for the metric. Will be derived from id if not provided explicitly.
title?: string;
v1.Metric.typeproperty
type: "metric";