Metric

Reusable semantic metric. Simple and cumulative metrics require agg; ratio metrics require numerator and denominator; derived metrics require expr and metrics; conversion metrics require base, conversion, and entity.

nameName (string)required

Stable metric name used by queries and derived-metric references.

typeType (string)required

Metric calculation type: simple, ratio, derived, cumulative, or conversion.

Possible values: [simple, ratio, derived, cumulative, conversion]

label object

Optional display label for the metric.

anyOf

• string
• null

string

description object

Human-readable explanation of the metric.

anyOf

• string
• null

string

synonymsstring[]

Alternative terms that may refer to the metric.

sortableSortable (boolean)

Whether the metric can be used for result ordering.

Default value: true

visibleVisible (boolean)

Default value: true

options object

Target-specific metric bindings.

anyOf

• object
• null

object

agg object

Aggregation for simple and cumulative metrics. Required for those types.

anyOf

• string
• null

string

Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

expr object

Column or row expression for simple and cumulative metrics, or arithmetic over metrics aliases for a derived metric.

anyOf

• string
• null

string

percentile object

Percentile fraction used when agg is percentile.

anyOf

• number
• null

number

clauses object[]

Array [

columnColumn (string)required

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

opOp (string)required

valueValue

granularity object

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

]

window object

Running time window for a cumulative metric. It cannot be combined with grain_to_date.

anyOf

• string
• null

string

grain_to_date object

Calendar-to-date grain for a cumulative metric. It cannot be combined with window.

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

numerator object

Numerator aggregation required for a ratio metric.

anyOf

• AggSpec
• null

aggAgg (string)required

Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

expr object

anyOf

• string
• null

string

percentile object

anyOf

• number
• null

number

clauses object[]

Array [

columnColumn (string)required

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

opOp (string)required

valueValue

granularity object

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

]

denominator object

Denominator aggregation required for a ratio metric.

anyOf

• AggSpec
• null

aggAgg (string)required

Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

expr object

anyOf

• string
• null

string

percentile object

anyOf

• number
• null

number

clauses object[]

Array [

columnColumn (string)required

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

opOp (string)required

valueValue

granularity object

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

]

base object

Base-event aggregation required for a conversion metric.

anyOf

• AggSpec
• null

aggAgg (string)required

Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

expr object

anyOf

• string
• null

string

percentile object

anyOf

• number
• null

number

clauses object[]

Array [

columnColumn (string)required

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

opOp (string)required

valueValue

granularity object

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

]

conversion object

Conversion-event aggregation required for a conversion metric.

anyOf

• AggSpec
• null

aggAgg (string)required

Possible values: [sum, avg, min, max, count, count_distinct, median, percentile]

expr object

anyOf

• string
• null

string

percentile object

anyOf

• number
• null

number

clauses object[]

Array [

columnColumn (string)required

Semantic column definition. Capability flags control filtering, sorting, grouping, and catalog visibility; values is exhaustive, samples is illustrative, and dictionary-backed columns suppress both value lists from semantic catalog output.

opOp (string)required

valueValue

granularity object

anyOf

• string
• null

string

Possible values: [day, week, month, quarter, year]

]

entity object

Column identifying the entity whose conversion is measured. Required for a conversion metric.

anyOf

• string
• null

string

metrics object[]

Metric references available to a derived metric expression. At least one is required for a derived metric.

Array [

nameName (string)required

alias object

anyOf

• string
• null

string

offset_window object

anyOf

• string
• null

string

]

Metric

{
  "name": "string",
  "type": "simple",
  "label": "string",
  "description": "string",
  "synonyms": [
    "string"
  ],
  "sortable": true,
  "visible": true,
  "options": {},
  "agg": "sum",
  "expr": "string",
  "percentile": 0,
  "clauses": [
    {
      "column": "string",
      "op": "string",
      "granularity": "day"
    }
  ],
  "window": "string",
  "grain_to_date": "day",
  "numerator": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
      {
        "column": "string",
        "op": "string",
        "granularity": "day"
      }
    ]
  },
  "denominator": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
      {
        "column": "string",
        "op": "string",
        "granularity": "day"
      }
    ]
  },
  "base": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
      {
        "column": "string",
        "op": "string",
        "granularity": "day"
      }
    ]
  },
  "conversion": {
    "agg": "sum",
    "expr": "string",
    "percentile": 0,
    "clauses": [
      {
        "column": "string",
        "op": "string",
        "granularity": "day"
      }
    ]
  },
  "entity": "string",
  "metrics": [
    {
      "name": "string",
      "alias": "string",
      "offset_window": "string"
    }
  ]
}