Measure parameters

Parameter	Description
aggregate_type	Defines the aggregation method for an underlying dimension.
ai_context	Free text that can provide context about a measure to the Omni Agent.
all_values	Provides the complete list of possible values to the Omni Agent for measures with a fixed set of values.
aliases	Maps old field names to updated field names to preserve content.
colors	Maps a color to the measure when it’s used as a series in a visualization.
custom_primary_key_sql	Defines a custom aggregation level for deduplication.
description	Provides metadata about the measure, made available in the workbook UI.
display_order	Overrides the sort order for the field picker within the field’s grouping.
drill_fields	Curates the drilling behavior for a measure using an array of fields for the subsequent query.
drill_queries	Defines multiple drill query options with full control over the underlying query.
filters	Applies filters to a measure for filtered aggregations.
format	Sets default or conditional formatting for numbers in Omni.
group_label	Nests a group of fields in the field picker for curated organization.
hidden	Removes the field from the UI while keeping it referenceable in the model.
ignored	Removes the field from the UI and prevents references to the field.
label	Overrides the field name for all UI appearances of the field.
links	Adds external links to templated URLs in the drill menu.
markdown	Mustache template rendered as Markdown in data table columns.
required_access_grants	Limits a user’s ability to query a field based on assigned user attributes.
sample_values	Provides sample values to the Omni Agent to better understand measure magnitude and usage.
sql	The core declaration of the field definition.
suggest_from_field	Suggests filter values from an alternative field’s distinct values.
suggestion_list	Explicitly sets the list of filter options, bypassing the default behavior.
synonyms	Alternative names that help the Omni Agent match user queries to the correct field.
tags	Tags for field picker search and field curation.
view_label	Nests a field under a different view than its default parent view.

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

Measure parameters