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.

Descriptions are visible in the workbook, specifically in the All views and fields panel in the workbook. For example, you could add copy that describes the type of analyses users can create using the view.

​
Syntax

# Single line description
description: <description_text>

# Multi-line description
description: |
  <multiline_description_text>

​
Properties

​
description
string
Free text that describes the view. For multiline descriptions or descriptions containing special characters like colons, use the pipe (|) syntax. Values should be unquoted.

​
Examples

Single line description
description: Transactions from our online store.
Multi-line description
description: |
  Transactions from all online subsidiaries.