Omni Analytics Documentation

https://docs.omni.co/
Admin
Omni is a business intelligence platform that combines a shared data model with SQL freedom,...
Tokens:966,953
Snippets:10,119
Trust Score:9.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize Guide Components

Source: https://docs.omni.co/guides/embed/omni-in-notion

Example usage of GuideSidebar and GuideTitle components with specific props.

```jsx
<GuideSidebar
  categoryIcons={categoryIcons}
  category="embed"
  updatedDate="April 2026"
  relatedLinks={[
{ title: "Embedding docs", href: "/embed" },
{ title: "Embedding in internal apps", href: "/guides/embed/omni-in-internal-app" },
{ title: "Embedding in Salesforce", href: "/guides/embed/omni-in-salesforce" }
]}
/>

<GuideTitle title="Embedding Omni in your Notion instance" />
```

--------------------------------

### Example Dashboard Configuration

Source: https://docs.omni.co/guides/migrations/looker-to-omni-skill

Sample setup for dashboard filters, layout, and tile mapping.

```python
ORDERS_VIEW, ORDERS_TOPIC = "analytics__orders", "orders"

SALES_FILTER_CONFIG = {"date_filter": {
    "type": "date", "label": "Date range",
    "fieldName": f"{ORDERS_TOPIC}.created[date]",
    "kind": "TIME_FOR_INTERVAL_DURATION",
    "left_side": "6 months ago", "right_side": "6 months", "is_negative": False,
}}
SALES_FILTER_ORDER = ["date_filter"]
SALES_LAYOUT = [
    {"i": "1", "x":  0, "y":  0, "w":  8, "h": 23},
    {"i": "2", "x":  8, "y":  0, "w":  8, "h": 23},
    {"i": "3", "x": 16, "y":  0, "w":  8, "h": 23},
    {"i": "4", "x":  0, "y": 23, "w": 24, "h": 30},
    {"i": "5", "x":  0, "y": 53, "w": 24, "h": 26},
]
_F_DATE = {"date_filter": f"{ORDERS_TOPIC}.created[date]"}
SALES_TILE_FILTER_MAP = {str(i): _F_DATE for i in range(1, 6)}
```

--------------------------------

### Specify My Documents content path

Source: https://docs.omni.co/embed/setup/url-parameters/contentPath

Example of setting the starting page to the user's My Documents folder.

```markdown
 contentPath=%2Fmy
```

--------------------------------

### Example configuration for included_schemas

Source: https://docs.omni.co/modeling/models/included-schemas

A practical example showing how to include the marketing and sales schemas.

```yaml
included_schemas:
  - marketing
  - sales
```

--------------------------------

### List Folders API Request Examples

Source: https://docs.omni.co/api/folders

Examples of how to perform a GET request to the folders endpoint across various programming languages.

```curl
curl --request GET \
  --url 'https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20' \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://blobsrus.omniapp.co/api/v1/folders?scope=organization&sortField=name&sortDirection=desc&pageSize=20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Filter examples for starts_with

Source: https://docs.omni.co/modeling/filters/operators/starts-with

Examples demonstrating standard prefix matching and case-insensitive configuration.

```yaml
users.email:
  starts_with: blob
```

```yaml
products.name:
  starts_with: BLOB-
```

```yaml
customers.name:
  starts_with: Blob
  case_insensitive: true
```

--------------------------------

### Private Key Configuration Example

Source: https://docs.omni.co/api/model-git-configuration/create-git-configuration

Example of providing a private key in the configuration.

```text
-----BEGIN OPENSSH PRIVATE KEY-----
...
```

--------------------------------

### Basic included_views example

Source: https://docs.omni.co/modeling/models/included-views

A simple configuration example listing specific views to include.

```yaml
included_views:
  - users
  - main.products
  - main__customers
```

--------------------------------

### Specify dashboard content path

Source: https://docs.omni.co/embed/setup/url-parameters/contentPath

Example of setting the starting page to a specific dashboard.

```markdown
contentPath=%2Fdashboards%2Fa6908f35
```

--------------------------------

### Specify workbook content path

Source: https://docs.omni.co/embed/setup/url-parameters/contentPath

Example of setting the starting page to a specific workbook.

```markdown
 contentPath=%2Fw%2Fa6908f35%2Fduplicate
```

--------------------------------

### Define base_view examples

Source: https://docs.omni.co/modeling/topics/parameters/base-view

Examples of setting the base_view parameter with and without a schema prefix.

```yaml
base_view: users
```

```yaml
base_view: main__users
```

--------------------------------

### Example AI Context Implementation

Source: https://docs.omni.co/modeling/measures/parameters/ai-context

A practical example of providing context for a product_cost measure.

```yaml
product_cost:
  ai_context: |
    Include this field when asked about product prices.
```

--------------------------------

### Example Composite Topics Configuration

Source: https://docs.omni.co/modeling/composite-topics/parameters/topics

A concrete example showing two topics being combined.

```yaml
topics: [orders_topic, marketing_topic]
```

--------------------------------

### VAR Function Examples

Source: https://docs.omni.co/analyze-explore/calculations/math-number

Examples of valid inputs for the VAR function.

```text
VAR(1)
VAR(A1)
VAR(A2:A25)
```

--------------------------------

### Example entityFolderContentRole

Source: https://docs.omni.co/embed/setup/url-parameters/entityFolderContentRole

An example of setting the entityFolderContentRole parameter to EDITOR.

```markdown
entityFolderContentRole=EDITOR
```

--------------------------------

### Example name parameter usage

Source: https://docs.omni.co/embed/setup/url-parameters/name

A practical example of the name parameter formatted for a URL.

```markdown
name=Blob+Ross
```

--------------------------------

### Example of display_order usage

Source: https://docs.omni.co/modeling/topics/parameters/display-order

A simple example assigning a display order of 3 to a topic.

```yaml
display_order: 3
```

--------------------------------

### Example of group_label usage

Source: https://docs.omni.co/modeling/topics/parameters/group-label

A practical example of assigning a topic to the 'Marketing' group.

```yaml
group_label: Marketing
```

--------------------------------

### Example entityFolderLabel

Source: https://docs.omni.co/embed/setup/url-parameters/entityFolderLabel

An example showing how to set the entity folder label to 'Blob Sales'.

```markdown
entityFolderLabel=Blob+Sales
```

--------------------------------

### Install Omni Python SDK

Source: https://docs.omni.co/guides/modeling/push-to-databricks-metric-views

Clone the repository and install dependencies to prepare the environment.

```bash
git clone https://github.com/exploreomni/omni-python-sdk.git
cd omni-python-sdk
pip install .
```

--------------------------------

### Date Interval Filter Examples

Source: https://docs.omni.co/analyze-explore/queries/filters

Examples of combining starting points and durations for interval filtering.

```text
# First ten days of 2023
[2023][10 days]
# 100 days ago for 10 days 
[100 complete days ago][10 days]
# 1 hour ago for 2000 milliseconds
[1 hour ago][2000 milliseconds]
```

--------------------------------

### Model YAML Response Example

Source: https://docs.omni.co/api/models/get-model-yaml

Example structure of the JSON response returned by the Get Model YAML endpoint.

```json
files:
  model.yaml: |-
    name: Test Model
    type: model
  views/customers.yaml: |-
    name: Customers
    fields: []
  views/orders.yaml: |-
    name: Orders
    fields: []
version: 1
viewNames: {}
```

--------------------------------

### Configure static week start day

Source: https://docs.omni.co/modeling/models/week-start-day

Example of setting the week start day to a specific day of the week.

```yaml
week_start_day: Sunday
```

--------------------------------

### Verify Node.js and npm installation

Source: https://docs.omni.co/ai/mcp/claude-desktop

Check that Node.js and npm are installed on your system before proceeding with API key setup.

```bash
node -v
npm -v
```

--------------------------------

### Initialize Guide Components

Source: https://docs.omni.co/guides/deployment/multi-instance-prod-stage

Implementation of the GuideSidebar and GuideTitle components with specific configuration props.

```jsx
<GuideSidebar
  categoryIcons={categoryIcons}
  category="deployment"
  updatedDate="March 2026"
  relatedLinks={[
{ title: "git follower mode setup", href: "/integrations/git/follower-mode/setup" },
{ title: "git follower mode best practices", href: "/integrations/git/follower-mode/best-practices" },
{ title: "Content Validator", href: "/modeling/develop/content-validator" },
{ title: "Migrating dashboards", href: "/visualize-present/dashboards/migrate" }
]}
/>

<GuideTitle title="Deploying Omni: Multiple instances (Prod/Stage)" />
```

--------------------------------

### Query Configuration Example

Source: https://docs.omni.co/modeling/query-views/parameters/query

A practical example showing field selection, base view definition, and sorting configuration.

```yaml
query:
  fields:
    users.age: age
    users.created_at[year]: created_at_year
  base_view: users
  sorts:
    - field: users.created_at[year]
```

--------------------------------

### Retrieve Content API Request Examples

Source: https://docs.omni.co/api/content

Examples for performing a GET request to the content endpoint using various programming languages and tools. All examples require a valid Bearer token for authorization.

```bash
curl --request GET \
  --url 'https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20' \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://blobsrus.omniapp.co/api/v1/content?scope=organization&sortField=name&pageSize=20")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Get Model AI Agent Actions Response Example

Source: https://docs.omni.co/api/models/get-model-ai-agent-actions

Example JSON response structure for a successful request to retrieve AI agent actions.

```json
success: true
records:
  - type: sample_query
    id: revenue_by_region
    label: Revenue by region
    description: Show total revenue grouped by region
    prompt: Show me revenue by region
  - type: skill
    id: analyze_trends
    label: Analyze trends
    description: Analyze trends in the data
    prompt: |-
      Skill: analyze_trends
      Analyze trends in revenue over time
```

--------------------------------

### Create Model Request Examples

Source: https://docs.omni.co/api/models

Examples for sending a POST request to create a model. Replace {instance} and <token> with your specific environment details.

```bash
curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelKind": "SCHEMA",
  "modelName": "<string>",
  "baseModelId": "<string>",
  "accessGrants": [],
  "allowAsWorkbookBase": false,
  "useIsolatedBranches": false
}
'
```

```python
import requests

url = "https://{instance}.omniapp.co/api/v1/models"

payload = {
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modelKind": "SCHEMA",
    "modelName": "<string>",
    "baseModelId": "<string>",
    "accessGrants": [],
    "allowAsWorkbookBase": False,
    "useIsolatedBranches": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

```javascript
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    modelKind: 'SCHEMA',
    modelName: '<string>',
    baseModelId: '<string>',
    accessGrants: [],
    allowAsWorkbookBase: false,
    useIsolatedBranches: false
  })
};

fetch('https://{instance}.omniapp.co/api/v1/models', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'modelKind' => 'SCHEMA',
    'modelName' => '<string>',
    'baseModelId' => '<string>',
    'accessGrants' => [
        
    ],
    'allowAsWorkbookBase' => false,
    'useIsolatedBranches' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/models"

	payload := strings.NewReader("{\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modelKind\": \"SCHEMA\",\n  \"modelName\": \"<string>\",\n  \"baseModelId\": \"<string>\",\n  \"accessGrants\": [],\n  \"allowAsWorkbookBase\": false,\n  \"useIsolatedBranches\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/v1/models")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modelKind\": \"SCHEMA\",\n  \"modelName\": \"<string>\",\n  \"baseModelId\": \"<string>\",\n  \"accessGrants\": [],\n  \"allowAsWorkbookBase\": false,\n  \"useIsolatedBranches\": false\n}")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"modelKind\": \"SCHEMA\",\n  \"modelName\": \"<string>\",\n  \"baseModelId\": \"<string>\",\n  \"accessGrants\": [],\n  \"allowAsWorkbookBase\": false,\n  \"useIsolatedBranches\": false\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Set week start day dynamically

Source: https://docs.omni.co/modeling/models/week-start-day

Example of using a user attribute to set the week start day based on the user's region.

```yaml
week_start_day: {{ omni_attributes.week_start }}
```

--------------------------------

### Create Connection Environments Request Example

Source: https://docs.omni.co/api/connection-environments/create-connection-environments

Example JSON payload for the createConnectionEnvironments operation.

```json
baseConnectionId: 123e4567-e89b-12d3-a456-426614174000
environmentConnectionIds: >-
  223e4567-e89b-12d3-a456-426614174001,323e4567-e89b-12d3-a456-426614174002
```

--------------------------------

### Configure access grant examples

Source: https://docs.omni.co/modeling/views/parameters/required-access-grants

Examples demonstrating single, OR, and combined AND/OR logic for access grants.

```yaml
required_access_grants: [ grant_one ]
```

```yaml
required_access_grants: [ grant_one|grant_two ]
```

```yaml
required_access_grants: [ grant_one|grant_two&grant_three ]
```

--------------------------------

### Render Guides Container

Source: https://docs.omni.co/guides

Example usage of the GuidesFilter component within a container layout.

```jsx
<div className="guides-container">
  <h1 className="guides-title">Guides</h1>

  <p className="guides-description">
    Step-by-step tutorials and best practices for getting the most out of Omni.
  </p>

  <GuidesFilter guides={guides} categoryIcons={categoryIcons} />
</div>
```

--------------------------------

### Enable Create Mode

Source: https://docs.omni.co/embed/setup/url-parameters/mode

Example of setting the mode to APPLICATION to enable full content system access.

```markdown
mode=APPLICATION
```

--------------------------------

### Execute CLI commands

Source: https://docs.omni.co/developers/cli/quickstart

Examples of basic commands to list resources or access help documentation.

```bash
omni models list
omni documents list
omni --help
```

--------------------------------

### Initialize GuideSidebar and GuideTitle

Source: https://docs.omni.co/guides/patterns/optimizing-ai-context-for-fintech

Configures the sidebar links and sets the page title for the fintech optimization guide.

```jsx
<GuideSidebar
  categoryIcons={categoryIcons}
  category="patterns"
  updatedDate="March 2026"
  relatedLinks={[
{ title: "Model-level ai_context", href: "/modeling/models/ai-context" },
{ title: "Topic-level ai_context", href: "/modeling/topics/parameters/ai-context" },
{ title: "View-level ai_context", href: "/modeling/views/parameters/ai-context" },
{ title: "Optimize models for Omni AI", href: "/modeling/develop/ai-optimization" }
]}
/>

<GuideTitle title="Optimizing AI context for fintech and banking" />
```

--------------------------------

### Initialize Guide Components

Source: https://docs.omni.co/guides/embed/ai-chat-agent

Usage of the GuideSidebar and GuideTitle components with specific configuration props.

```jsx
<GuideSidebar categoryIcons={categoryIcons} category="embed" updatedDate="March 2026" />

<GuideTitle title="Connect a chat agent to Omni AI for embed experiences" />
```

--------------------------------

### Omni dashboards usage examples

Source: https://docs.omni.co/developers/cli/commands

Examples for initiating a dashboard download and viewing help for filter updates.

```bash
# Download dashboard
omni dashboards download <dashboardid>

# View help for update-filters command, including arguments and flag details
omni dashboards update-filters --help
```

--------------------------------

### GET /Users

Source: https://docs.omni.co/api/users/list-users

Retrieves a list of users based on optional filter, count, and start index parameters.

```APIDOC
## GET /Users

### Description
Retrieves a paginated list of users. Supports filtering by username using 'eq' (exact match) or 'co' (contains substring) operators.

### Method
GET

### Endpoint
/Users

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter expression for users (e.g., userName eq "user@example.com")
- **count** (integer) - Optional - The number of users to return per page (default: 100)
- **startIndex** (integer) - Optional - The starting point of the result list (default: 1)

### Response
#### Success Response (200)
- **Resources** (array) - The list of users
- **schemas** (array) - SCIM schema information
- **itemsPerPage** (integer) - The number of users returned in the current page
- **totalResults** (integer) - The total number of users matching the query
- **startIndex** (integer) - The starting index of the current page

#### Response Example
{
  "Resources": [
    {
      "active": true,
      "displayName": "Blob Ross",
      "emails": [
        {
          "primary": true,
          "value": "blob.ross@blobsrus.co"
        }
      ],
      "id": "9e8719d9-276a-4964-9395-a493189a247c",
      "userName": "blob.ross@blobsrus.co"
    }
  ],
  "itemsPerPage": 1,
  "totalResults": 1,
  "startIndex": 1
}
```

--------------------------------

### Example of owners configuration

Source: https://docs.omni.co/modeling/topics/parameters/owners

A concrete example showing how to list multiple email addresses for topic owners.

```yaml
owners: [blobby@blobsrus.com, blob.ross@blobsrus.com]
```

--------------------------------

### dbt Exposure API Response Example

Source: https://docs.omni.co/api/dbt/get-dbt-exposures

A sample JSON response structure returned by the get dbt exposures endpoint.

```json
example:
  pageInfo:
    hasNextPage: false
    nextCursor: null
    pageSize: 1000
    totalRecords: 1
  records:
    - dashboard_identifier: abc123
      deduplication_name: sales_overview_abc123
      exposure:
        name: sales_overview
        type: dashboard
        owner:
          name: Blob Ross
          email: blob.ross@blobsrus.com
        depends_on:
          - ref('orders')
          - ref('customers')
        label: Sales Overview
        url: https://your-org.omni.co/dashboards/abc123
```

--------------------------------

### Define static fiscal month offsets

Source: https://docs.omni.co/modeling/models/fiscal-month-offset

Examples of static integer values to shift the fiscal calendar start date.

```yaml
fiscal_month_offset: 11
```

```yaml
fiscal_month_offset: 10
```

```yaml
fiscal_month_offset: -1
```

--------------------------------

### Configure Cache Policy Examples

Source: https://docs.omni.co/modeling/models/cache-policies

Examples showing how to set specific cache durations and filter suggestion behaviors.

```yaml
cache_policies:
  dont_cache_at_all:
    max_cache_age: 0 seconds
    filter_suggestions_must_obey_policy: false       # Retain filter suggestions for 30 days
```

```yaml
cache_policies:
  cache_for_a_day:
    max_cache_age: 24 hours
    filter_suggestions_must_obey_policy: true        # Obey cache policy & retain for 24 hours
```

--------------------------------

### Example topic group descriptions configuration

Source: https://docs.omni.co/modeling/models/topic-group-descriptions

A practical example showing how to map specific group labels to descriptive strings.

```yaml
topic_group_descriptions:
  Sales: Topics related to sales data
  Marketing: Topics for marketing analytics
```

--------------------------------

### Project duration with all intervals example

Source: https://docs.omni.co/modeling/dimensions/parameters/duration

Calculates the duration between project start and end dates across all supported long-term intervals.

```yaml
project_length:
  duration:
    sql_start: ${projects.start_date}
    sql_end: ${projects.end_date}
    intervals: [days, weeks, months, quarters, years]
```

--------------------------------

### List User Attributes API Requests

Source: https://docs.omni.co/api/user-attributes

Examples of how to perform a GET request to the user-attributes endpoint across different programming languages.

```bash
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/user-attributes \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://{instance}.omniapp.co/api/v1/user-attributes"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.omniapp.co/api/v1/user-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/user-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/user-attributes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/user-attributes")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/user-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Database connection string examples

Source: https://docs.omni.co/connect-data/setup/quick-connect

Examples of connection strings for various supported database systems.

```text
databricks://token:dapi123abc@workspace.cloud.databricks.com:443/default?http_path=/sql/1.0/warehouses/abc123
```

```text
mssql://omni_user:password@db.example.com:1433/analytics?schema=dbo
```

```text
mysql://omni_user:password@db.example.com:3306/analytics
```

```text
postgresql://omni_user:password@db.example.com:5432/analytics
```

```text
snowflake://omni_user:password@account.snowflakecomputing.com/database?warehouse=COMPUTE_WH
```

--------------------------------

### Render Guide Sidebar and Title Components

Source: https://docs.omni.co/guides/deployment/multi-instance-prod-stage

React components for rendering the guide sidebar with related links and the guide header title.

```jsx
{relatedLinks && relatedLinks.length > 0 && <div className="guide-sidebar-section">
            <div className="guide-sidebar-label">Related</div>
            <ul className="guide-sidebar-links">
              {relatedLinks.map((link, index) => <li key={index}>
                  <a href={link.href}>{link.title}</a>
                </li>)}
            </ul>
          </div>}
      </div>
    </aside>;
};

export const GuideTitle = ({title}) => {
  return <div className="guide-header">
      <h1 className="guide-title">{title}</h1>
    </div>;
};
```

--------------------------------

### Omni uploads operational examples

Source: https://docs.omni.co/developers/cli/commands

Examples for listing uploads with a search term and viewing help for the create command.

```bash
# List uploads with 'country' in file name
omni uploads list --searchterm "country"

# View help for create command, including arguments and flag details
omni uploads create --help
```

--------------------------------

### EvalPrompt Schema Example

Source: https://docs.omni.co/api/ai-eval/get-an-eval-prompt-set

Example object structure for an EvalPrompt.

```json
{
  "created_at": "2025-01-15T10:00:00.000Z",
  "expectation": "The top product by revenue should be Aniseed Syrup.",
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "prompt_text": "The natural language prompt text the AI is evaluated on."
}
```

--------------------------------

### EvalPromptSet Schema Example

Source: https://docs.omni.co/api/ai-eval/get-an-eval-prompt-set

Example object structure for an EvalPromptSet.

```json
{
  "created_at": "2025-01-15T10:00:00.000Z",
  "description": "Regression suite for the orders topic",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "is_archived": false,
  "model_id": "880e8400-e29b-41d4-a716-446655440003",
  "name": "Orders regression",
  "prompts": [],
  "slug": "orders-regression",
  "updated_at": "2025-01-15T10:00:00.000Z"
}
```

--------------------------------

### Example of uploaded_table_name

Source: https://docs.omni.co/modeling/views/parameters/uploaded-table-name

A concrete example showing a CSV file identifier.

```yaml
uploaded_table_name: products.csv::1a3497f5-cba8-47c0-bab9-b2df84d1b141
```

--------------------------------

### Omni models usage examples

Source: https://docs.omni.co/developers/cli/commands

Examples for listing models, creating branches, and accessing help documentation.

```bash
# List models (including IDs)
omni models list --compact

# Create a branch of a model
omni models create-branch <model-id> --name "add-new-columns"

# View help for yaml-create command, including arguments and flag details
omni models yaml-create --help
```

--------------------------------

### day_of_quarter Examples

Source: https://docs.omni.co/modeling/filters/operators/day-of-quarter

Examples showing how to filter for specific days of the quarter.

```yaml
users.created_at:
  day_of_quarter: "1"
```

```yaml
users.created_at:
  day_of_quarter: "92"
```

--------------------------------

### Omni query usage examples

Source: https://docs.omni.co/developers/cli/commands

Examples for running a semantic query and accessing help for query commands.

```bash
# Run a semantic query
omni query run --body '{"modelId":"MODEL_ID","query":{"fields":["view_name/field_name"],"limit":100}}'

# View help for wait command, including arguments and flag details
omni query wait --help
```

--------------------------------

### Example externalId

Source: https://docs.omni.co/embed/setup/url-parameters/externalId

A concrete example of the externalId parameter with a sample value.

```markdown
externalId=ohtani17
```

--------------------------------

### Print AI agent usage guide

Source: https://docs.omni.co/developers/cli/commands

Displays a concise usage guide formatted for AI agents.

```bash
omni agent-help
```

--------------------------------

### Upload Response Example

Source: https://docs.omni.co/api/uploads/list-uploads

Example structure for a successful upload response.

```yaml
connection_id: 660e8400-e29b-41d4-a716-446655440001
in_db_as_table_name: omni_upload_t550e8400
model_id: 880e8400-e29b-41d4-a716-446655440003
size_bytes: 1024
created_at: '2025-01-15T10:00:00Z'
updated_at: '2025-01-15T10:00:00Z'
uploaded_by_user:
  id: 770e8400-e29b-41d4-a716-446655440002
  name: John Doe
```

--------------------------------

### Git Configuration Example Values

Source: https://docs.omni.co/api/model-git-configuration/update-git-configuration

Example values for specific Git configuration fields including web URL, private key, and passphrase.

```yaml
example: users-only
```

```yaml
example: https://github.com/org/repo
```

```yaml
-----BEGIN OPENSSH PRIVATE KEY-----
...
```

```yaml
example: my-secure-passphrase
```

--------------------------------

### Request Body Example

Source: https://docs.omni.co/api/documents/duplicate-published-document

Example payload for the document duplication request.

```json
name: My Dashboard Copy
folderPath: /reports/2024/q4
scope: organization
```

--------------------------------

### VAR.P Function Examples

Source: https://docs.omni.co/analyze-explore/calculations/math-number

Examples of valid inputs for the VAR.P function.

```text
VAR.P(1)
VAR.P(A1)
VAR.P(A2:A25)
```

--------------------------------

### Common folder operations

Source: https://docs.omni.co/developers/cli/commands

Examples for listing, creating, and viewing help for folder permissions commands.

```bash
# List folders
omni folders list

# Create a folder
omni folders create --body '{"name":"Blob Sales"}'

# View help for revoke-permissions command, including arguments and flag details
omni folders revoke-permissions --help
```

--------------------------------

### Initialize CLI profile

Source: https://docs.omni.co/developers/cli/quickstart

Creates a new profile containing organization, API endpoint, and authentication settings.

```bash
omni config init
```

--------------------------------

### BITRSHIFT Bitwise Function Example

Source: https://docs.omni.co/analyze-explore/calculations/logic

Example usage of the BITRSHIFT function.

```text
BITRSHIFT(8, 2)
```

--------------------------------

### Manage Email-Only User Request Examples

Source: https://docs.omni.co/api/schedule-recipients/manage-email-only-user

Examples demonstrating basic user creation, setting user attributes, and unsetting attributes via the request body.

```json
email: iamagoodblob@blobsrus.co
```

```json
email: iamagoodblob@blobsrus.co
userAttributes:
  region:
    - US
    - EU
  omni_user_timezone: America/New_York
  is_admin: 0
  is_sales_team: 1
```

```json
email: iamagoodblob@blobsrus.co
userAttributes:
  is_admin: null
  is_sales_team: ''
  region: []
```

--------------------------------

### BITOR Bitwise Function Example

Source: https://docs.omni.co/analyze-explore/calculations/logic

Example usage of the BITOR function.

```text
BITOR(6, 3)
```

--------------------------------

### Example of shared views configuration

Source: https://docs.omni.co/modeling/composite-topics/parameters/shared-views

A practical example showing date_spine and regions defined as shared views.

```yaml
shared_views: [date_spine, regions]
```

--------------------------------

### BITAND Bitwise Function Example

Source: https://docs.omni.co/analyze-explore/calculations/logic

Example usage of the BITAND function.

```text
BITAND(6, 3)
```

--------------------------------

### GuideSidebar and GuideTitle Component Usage

Source: https://docs.omni.co/guides/modeling/date-flexibility-templated-filters

Example implementation of the GuideSidebar and GuideTitle components used to structure the documentation page.

```jsx
{relatedLinks && relatedLinks.length > 0 && <div className="guide-sidebar-section">
            <div className="guide-sidebar-label">Related</div>
            <ul className="guide-sidebar-links">
              {relatedLinks.map((link, index) => <li key={index}>
                  <a href={link.href}>{link.title}</a>
                </li>)}
            </ul>
          </div>}
      </div>
    </aside>;
};

export const GuideTitle = ({title}) => {
  return <div className="guide-header">
      <h1 className="guide-title">{title}</h1>
    </div>;
};
```

```jsx
<GuideSidebar
  categoryIcons={categoryIcons}
  category="modeling"
  updatedDate="April 2026"
  relatedLinks={[
{ title: "Templated filters", href: "/modeling/templated-filters" },
{ title: "Filter-only fields", href: "/modeling/templated-filters/parameters" },
{ title: "Dashboard controls", href: "/visualize-present/dashboards/controls" },
{ title: "Dashboard filters", href: "/visualize-present/dashboards/filters" }
]}
/>

<GuideTitle title="Improving date flexibility with templated filters" />
```

--------------------------------

### Example Topic Label

Source: https://docs.omni.co/modeling/topics/parameters/label

A simple example of setting a topic label to 'California'.

```yaml
label: California
```

--------------------------------

### Create User via SCIM API

Source: https://docs.omni.co/api/users

Examples for sending a POST request to create a user. Replace {instance} and <token> with your specific environment details.

```bash
curl --request POST \
  --url https://{instance}.omniapp.co/api/scim/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Blob Ross",
  "userName": "blob.ross@blobsrus.com",
  "urn:omni:params:1.0:UserAttribute": {
    "good_blob": true
  }
}
'
```

```python
import requests

url = "https://{instance}.omniapp.co/api/scim/v2/users"

payload = {
    "displayName": "Blob Ross",
    "userName": "blob.ross@blobsrus.com",
    "urn:omni:params:1.0:UserAttribute": { "good_blob": True }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

```javascript
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: 'Blob Ross',
    userName: 'blob.ross@blobsrus.com',
    'urn:omni:params:1.0:UserAttribute': {good_blob: true}
  })
};

fetch('https://{instance}.omniapp.co/api/scim/v2/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/scim/v2/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => 'Blob Ross',
    'userName' => 'blob.ross@blobsrus.com',
    'urn:omni:params:1.0:UserAttribute' => [
        'good_blob' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/scim/v2/users"

	payload := strings.NewReader("{\n  \"displayName\": \"Blob Ross\",\n  \"userName\": \"blob.ross@blobsrus.com\",\n  \"urn:omni:params:1.0:UserAttribute\": {\n    \"good_blob\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.post("https://{instance}.omniapp.co/api/scim/v2/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"Blob Ross\",\n  \"userName\": \"blob.ross@blobsrus.com\",\n  \"urn:omni:params:1.0:UserAttribute\": {\n    \"good_blob\": true\n  }\n}")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/scim/v2/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"Blob Ross\",\n  \"userName\": \"blob.ross@blobsrus.com\",\n  \"urn:omni:params:1.0:UserAttribute\": {\n    \"good_blob\": true\n  }\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### Example of ignoring a schema

Source: https://docs.omni.co/modeling/models/ignored-schemas

A basic example demonstrating how to exclude the information_schema from workbooks.

```yaml
ignored_schemas:
  - information_schema
```

--------------------------------

### Basic function examples

Source: https://docs.omni.co/analyze-explore/calculations/index

Examples of simple functions for returning current date and time values.

```text
NOW()           # Returns the current date and time, ex: 2025-05-09 18:23:30.521
TODAY()         # Returns the current date, ex: 2025-05-09
```

--------------------------------

### Between operator examples

Source: https://docs.omni.co/modeling/filters/operators/between

Examples demonstrating how to filter numeric fields using the between operator.

```yaml
orders.total_price:
  between: [10.00, 100.00]
```

```yaml
users.age:
  between: [18, 30]
```

--------------------------------

### Enable AccessBoost

Source: https://docs.omni.co/embed/setup/url-parameters/accessBoost

Example of enabling AccessBoost using the URL parameter.

```markdown
accessBoost=true
```

--------------------------------

### Example filter

Source: https://docs.omni.co/embed/setup/url-parameters/filterSearchParam

A URL encoded example of a filter specification applied to the filterSearchParam.

```markdown
filterSearchParam=f--rW8-IWVU=%7B%22values%22%3A%5B%22closed%22%5D%7D
```

--------------------------------

### User Creation Response Example

Source: https://docs.omni.co/api/users/create-user

Example JSON response body returned upon successful user creation.

```json
active: true
displayName: Blob Ross
emails:
  - primary: true
    value: blob.ross@blobsrus.co
groups: []
id: 9e8719d9-276a-4964-9395-a493189a247c
meta:
  created: '2024-12-03T23:13:14.109Z'
  lastModified: '2024-12-03T23:13:14.109Z'
  resourceType: User
schemas:
  - urn:ietf:params:scim:schemas:core:2.0:User
userName: blob.ross@blobsrus.co
urn:omni:params:1.0:UserAttribute:
  good_blob: 'yes'
```

--------------------------------

### User Attribute Example

Source: https://docs.omni.co/api/users

Example format for the custom user attribute object.

```json
{ "good_blob": true }
```

--------------------------------

### Omni scim usage examples

Source: https://docs.omni.co/developers/cli/commands

Examples for listing SCIM groups and accessing help for user creation commands.

```bash
# List maximum of 10 groups
omni scim groups-list --count "10"

# View help for users-create command, including arguments and flag details
omni scim users-create --help
```

--------------------------------

### Document Identifier Parameter Example

Source: https://docs.omni.co/api/documents/upgrade-dashboard-layout

Example value for the identifier path parameter.

```text
abc123
```

--------------------------------

### Install Omni CLI via script

Source: https://docs.omni.co/developers/cli/install

Downloads the latest release and installs the binary to /usr/local/bin or ~/.local/bin.

```bash
curl -fsSL https://raw.githubusercontent.com/exploreomni/cli/main/install.sh | sh
```

--------------------------------

### Initialize and Start omni-sync

Source: https://docs.omni.co/guides/migrations/looker-to-omni-skill

Initialize a migration branch and start the watcher process for model synchronization.

```bash
omni-sync init <your_model_id> --branch looker-migration --create-branch
omni-sync start <your_model_id>
```
Tokens:
Raw