Skip to main content
ParameterDescription
ai_contextProvides context to the AI query helper for better understanding of field usage.
aliasesMaps old field names to updated field names to preserve content.
bin_boundariesSpecifies bins or tiers for a given numeric field.
colorsDefines colors to map to specific dimension values.
convert_tzControls whether a field should be converted to the query/user timezone.
custom_primary_key_sql_for_quick_aggsDefines a custom primary key for aggregate measures where a primary key is applicable.
descriptionProvides metadata about the dimension, made available in the workbook UI.
display_orderOverrides the sort order for the field picker within a view.
drill_fieldsEnables hierarchical drilling inside a row of the result set.
filter_single_select_onlyRestricts a dimension to only allow single-value style filters.
formatSets default formatting for number and date dimensions.
group_byCreates a Level of Detail field, which controls the granularity at which an aggregation is computed.
group_labelNests a group of fields in the field picker for curated organization.
groupsBuckets results with CASE-like logic by filtering field values into labeled groups.
hiddenRemoves the field from the UI while keeping it referenceable in the model.
ignore_from_extendedControls whether a field should be omitted during explicit extensions of a view.
ignoredRemoves a field from the UI and prevents references to it.
labelOverrides the field name for all UI appearances.
linksAdds external links to templated URLs in the drill menu.
order_by_fieldSets a field to be sorted by another field’s values.
primary_keySets the primary key on a view for preventing fan outs in calculations.
required_access_grantsDefines a list of access grants for the dimension, which are used to control access.
sqlThe core declaration of the field definition using SQL.
suggest_from_fieldSpecifies an alternative field to use for filter suggestions.
suggest_from_topicExplicitly sets the topic to use for filter suggestions.
suggestion_listExplicitly sets the list of filter options, bypassing default behavior.
tagsMetadata used for field search in workbooks, curating fields, and curating drill fields.
timeframesSets the default time segments available for date/time fields in workbooks.
view_labelNests a field under a different view than its default parent view.