Skip to main content

Semantic Layer configurations

The Semantic Layer YAML spec defines every property and option for semantic models, metrics, and dimensions. Use it when you need the complete, authoritative list of what you can configure. For example, configurations when defining new objects, validating YAML, or troubleshooting config errors.

Because this reference provides information about both the latest spec (model-embedded) and the legacy spec (standalone YAML), you'll need to select the appropriate version from the version picker. Read the build docs to find out which applies to your environment. To convert from the legacy spec, see Migrate to the latest YAML spec.

Property reference​

The property reference pages document each resource type in detail so you can look up allowed values, syntax, and behavior for every property in the full YAML spec. Use the version picker on each page to see latest spec (model YAML) or legacy spec (standalone YAML) content:

Where to define Semantic Layer objects​

ObjectLatest spec (model YAML)Legacy spec (standalone YAML)
Semantic modelsTop-level semantic_model: block under models.Top-level semantic_models: list.
MetricsFor metrics that only depend on the same semantic model, nest them directly under each model in models: (but not nested under semantic_model).

For metrics that depend on metrics or dimensions from a different semantic model, define them under a top-level metrics: block (For example, outside models:). This can be in the same YAML file or a separate one.		Top-level metrics: key in standalone YAML.
Dimensionsdimension: blocks on model columns (and optional derived_semantics.dimensions). Defined within a model's semantic layer configuration.dimensions: list on the semantic model. Defined within a model's semantic layer configuration.
Loading table...

For the complete structure and examples, refer to these build docs:

  • Build your metrics: Conceptual overview of the Semantic Layer, metric types, and how to get started.
  • Semantic models: How to define semantic models (on a model or standalone), structure, and examples.
  • Creating metrics: How to create and configure metrics; links to type-specific guides (simple, cumulative, ratio, derived, conversion).
  • Dimensions: How to define time and categorical dimensions within semantic models.
  • Migrate to the latest YAML spec: How to migrate from the legacy metrics YAML spec to the latest spec.

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0
Loading