GoodData.UI API reference
  • All Products
  • All Products
  • GoodData.UI
  • API Reference
  • University
  • Community
  • Documentation
  • Support
  • 11.28.0
  • Code samples
  • GitHub

Metric

Home > @gooddata/sdk-code-schemas > v1 > Metric

v1.Metric interface

Signature:

export interface Metric 

Properties

Property

Modifiers

Type

Description

description?

string

(Optional) An optional description of the metric.

format?

string

(Optional) Metric value default format

id

Id5

is_hidden?

boolean

(Optional)

maql

string

Define MAQL syntax for metric.

show_in_ai_results?

boolean

(Optional) Optional flag to indicate if the metric should be shown in AI results. When omitted, the metric is visible.

tags?

Tags7

(Optional)

title?

string

(Optional) An optional human readable title for the metric. Will be derived from id if not provided explicitly.

type

"metric"

  • v1.Metric interface
  • Properties
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2026 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use