v1.ComputedAttribute
export interface ComputedAttribute
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
“INT” | “STRING” | “DATE” | “NUMERIC” | “TIMESTAMP” | “TIMESTAMP_TZ” | “BOOLEAN” | “HLL” | (Optional) An optional data type of the computed values. Defaults to STRING on the backend. | ||
string | (Optional) An optional description of the computed attribute. | ||
string | (Optional) An optional Excel-like format string applied to the computed values. | ||
boolean | (Optional) Optional flag to indicate if the computed attribute can contain null values. | ||
(Optional) | |||
string | Define MAQL syntax for the computed attribute. Values are assigned with break points written as CASE WHEN branches over a metric, and the first matching branch wins. | ||
“UNSPECIFIED” | “CURRENCY” | (Optional) An optional categorization of the computed values semantics, for example currency. | ||
string | (Optional) Optional value which can be used as replacement for NULL in join conditions. | ||
boolean | (Optional) Optional flag to indicate if the computed attribute should be shown in AI results. When omitted, the computed attribute is visible. | ||
(Optional) | |||
string | (Optional) An optional human readable title for the computed attribute. Will be derived from id if not provided explicitly. | ||
“computed_attribute” | |||
“TEXT” | “HYPERLINK” | “GEO” | “GEO_LONGITUDE” | “GEO_LATITUDE” | “GEO_AREA” | “GEO_ICON” | “IMAGE” | “HYPERLOGLOG” | (Optional) An optional specific type of the computed values. Defaults to TEXT on the backend. |
Property details
v1.ComputedAttribute.data_typeproperty
An optional data type of the computed values. Defaults to STRING on the backend.
data_type?: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
v1.ComputedAttribute.descriptionproperty
An optional description of the computed attribute.
description?: string;
v1.ComputedAttribute.formatproperty
An optional Excel-like format string applied to the computed values.
format?: string;
v1.ComputedAttribute.idproperty
id: Id8;
v1.ComputedAttribute.is_nullableproperty
Optional flag to indicate if the computed attribute can contain null values.
is_nullable?: boolean;
v1.ComputedAttribute.localeproperty
locale?: Locale3;
v1.ComputedAttribute.maqlproperty
Define MAQL syntax for the computed attribute. Values are assigned with break points written as CASE WHEN branches over a metric, and the first matching branch wins.
maql: string;
v1.ComputedAttribute.metric_typeproperty
An optional categorization of the computed values semantics, for example currency.
metric_type?: "UNSPECIFIED" | "CURRENCY";
v1.ComputedAttribute.null_value_join_replacementproperty
Optional value which can be used as replacement for NULL in join conditions.
null_value_join_replacement?: string;
v1.ComputedAttribute.show_in_ai_resultsproperty
Optional flag to indicate if the computed attribute should be shown in AI results. When omitted, the computed attribute is visible.
show_in_ai_results?: boolean;
v1.ComputedAttribute.tagsproperty
tags?: Tags9;
v1.ComputedAttribute.titleproperty
An optional human readable title for the computed attribute. Will be derived from id if not provided explicitly.
title?: string;
v1.ComputedAttribute.typeproperty
type: "computed_attribute";
v1.ComputedAttribute.value_typeproperty
An optional specific type of the computed values. Defaults to TEXT on the backend.
value_type?: "TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_AREA" | "GEO_ICON" | "IMAGE" | "HYPERLOGLOG";