Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

ParameterDescription
ai_contextFree text that can provide context about a query view to the Omni Agent.
base_viewReferences the view that is used in the FROM of the generated SQL.
bind_all_filtersPasses all chosen filters from the outer query into the query view definition.
bindPasses filter values from other fields into the subquery defined in a query view.
calculationsLists the calculations defined in the query.
default_group_byEnables or disables a GROUP BY in the query.
descriptionFree text that describes the query view.
dimensionsLists all fields selected in the query, making them into dimensions to allow for aggregation in another query.
display_orderOverrides the sort order for views in the field browser.
fieldsLists the fields in the query.
fill_fieldsEnsures that the query returns continuous values for specific dimensions, even when no underlying rows exist.
filtersDefines the filters applied in the query.
hiddenRemoves a query view from the workbook UI while keeping it referenceable in the model.
ignoredSoft-deletes a query view in the model.
join_via_mapMaps joins when the query view is based on SQL and the joins are non-default joins.
labelOverrides the name of the query view in the UI.
limitDefines the row limit of the query if a limit is set on the query in the workbook.
measuresDescribes how to aggregate data in the query.
queryDefines the underlying query for the query view.
schemaReferences the querys underlying schema name from the associated database connection.”
sortsDefines the field(s) that the query is sorted by.
sqlDefines the SQL query used by the query view.
tagsCurates view and field groups for organizing and grouping views in the UI.
topicSpecifies the topic used by the query.