SemanticTableCreate

Payload used to create Semantic Table. The required field is name.

nameName (string)required

typeType (string)

Possible values: [clickhouse, postgres, odata_v2, odata_v4]

Default value: clickhouse

alias object

anyOf

• string
• null

string

collection_id object

Identifier of the containing collection.

anyOf

• string
• null

string

Possible values: non-empty

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

description object

anyOf

• string
• null

string

connector object

anyOf

• string
• null

string

commentsstring[]

instructionsstring[]

columns object[]

Array [

nameName (string)required

Physical column name, unless a computed expression in options.sql.expr replaces it for supported SQL targets.

kindKind (string)

Semantic column kind: categorical or time.

Possible values: [categorical, time]

Default value: categorical

description object

Human-readable explanation of the column.

anyOf

• string
• null

string

filterableFilterable (boolean)

Whether the column can be used in filter conditions.

Default value: true

sortableSortable (boolean)

Whether the column can be used for result ordering.

Default value: true

groupableGroupable (boolean)

Whether the column can be selected or used for grouping.

Default value: true

visibleVisible (boolean)

Whether the column is exposed in the semantic catalog. Hidden columns remain available to authored filters and templates.

Default value: true

synonymsstring[]

Alternative terms that may refer to the column.

valuesstring[]

Exhaustive values for a low-cardinality column. Omitted from semantic catalog output when dictionary is set.

samplesstring[]

Illustrative, non-exhaustive example values. Omitted from semantic catalog output when dictionary is set.

dictionary object

Dictionary used to resolve canonical values and surface-form synonyms.

anyOf

• ColumnDictionary
• null

builtin object

anyOf

• object
• null

object

external object

anyOf

• string
• null

string

options object

Target-specific column bindings, including an optional computed SQL expression.

anyOf

• object
• null

object

]

metrics object[]

Array [

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

]

]

filters object[]

Array [

nameName (string)required

clauses object[]required

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]

]

label object

anyOf

• string
• null

string

description object

anyOf

• string
• null

string

synonymsstring[]

visibleVisible (boolean)

Default value: true

]

linksstring[]

options object

anyOf

• object
• null

object

SemanticTableCreate

{
  "name": "string",
  "type": "clickhouse",
  "alias": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "connector": "string",
  "comments": [
    "string"
  ],
  "instructions": [
    "string"
  ],
  "columns": [
    {
      "name": "string",
      "kind": "categorical",
      "description": "string",
      "filterable": true,
      "sortable": true,
      "groupable": true,
      "visible": true,
      "synonyms": [
        "string"
      ],
      "values": [
        "string"
      ],
      "samples": [
        "string"
      ],
      "dictionary": {
        "builtin": {},
        "external": "string"
      },
      "options": {}
    }
  ],
  "metrics": [
    {
      "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"
        }
      ]
    }
  ],
  "filters": [
    {
      "name": "string",
      "clauses": [
        {
          "column": "string",
          "op": "string",
          "granularity": "day"
        }
      ],
      "label": "string",
      "description": "string",
      "synonyms": [
        "string"
      ],
      "visible": true
    }
  ],
  "links": [
    "string"
  ],
  "options": {}
}