Validate content

curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator"

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator",
  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;
}

package main

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

func main() {

	url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "model_id": "550e8400-e29b-41d4-a716-446655440000",
  "branch": null,
  "content": [
    {
      "document_id": "abc123",
      "identifier": "dashboard-1",
      "name": "Sales Dashboard",
      "type": "Published",
      "updated_at": "2025-01-15T10:00:00Z",
      "folder": {
        "name": "Reports",
        "path": "/Reports"
      },
      "owner": {
        "email": "user@example.com",
        "name": "Jane Doe"
      },
      "require_pull_request_to_publish": false,
      "queries_and_issues": [
        {
          "query_name": "Total Revenue",
          "query_presentation_id": "qp-123",
          "query_id_map_key": "1",
          "issues": [
            "Field 'orders.old_field' not found in model"
          ]
        }
      ],
      "dashboard_filter_issues": []
    }
  ]
}

Content validator

Validate content

Validate all content against the model and return documents with queries and any validation issues.

This endpoint scans all documents associated with the model and identifies any fields, views, or other model elements referenced in queries that are no longer valid.

You can optionally scope validation to only content that references a specific model element (view, field, or topic) using the find and find_type parameters. This is useful when you only need to validate content using a specific element, avoiding the overhead of validating all documents.

GET

models

{modelId}

content-validator

Validate content

curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator"

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator",
  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;
}

package main

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

func main() {

	url := "https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "model_id": "550e8400-e29b-41d4-a716-446655440000",
  "branch": null,
  "content": [
    {
      "document_id": "abc123",
      "identifier": "dashboard-1",
      "name": "Sales Dashboard",
      "type": "Published",
      "updated_at": "2025-01-15T10:00:00Z",
      "folder": {
        "name": "Reports",
        "path": "/Reports"
      },
      "owner": {
        "email": "user@example.com",
        "name": "Jane Doe"
      },
      "require_pull_request_to_publish": false,
      "queries_and_issues": [
        {
          "query_name": "Total Revenue",
          "query_presentation_id": "qp-123",
          "query_id_map_key": "1",
          "issues": [
            "Field 'orders.old_field' not found in model"
          ]
        }
      ],
      "dashboard_filter_issues": []
    }
  ]
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId

string<uuid>

required

The ID of the model to validate content against.

Query Parameters

branch_id

string<uuid>

The ID of the branch to validate against. If not provided, validates against the main model.

userId

string<uuid>

The user ID to act on behalf of. Only valid when using an organization API key.

User-scoped API keys cannot use this parameter and will receive a 403 error if provided.

include_personal_folders

boolean

When enabled, include personal folders in the search.

find

string

The name of the model element to find content references for. Must be used together with find_type.

For FIELD type, the value must be fully qualified with the view name (e.g., orders.status).

find_type

enum<string>

The type of model element to search for. Must be used together with find.

When both parameters are provided, only content that references the specified element will be validated and included in the response.

Available options:

VIEW,

FIELD,

TOPIC

force_full_validation

boolean

default:false

By default, validation of a large set of queries only checks field, view, and topic references, which can miss breakage in sorts, pivots, or totals. Enable this parameter to validate every query at full depth. Validation is slower on large models.

content_filter_mode

enum<string>

default:ALL

Filter documents by validation status.

ALL - Return all documents with at least one query.
WITH_ISSUES - Return only documents with at least one query issue, dashboard filter issue, or document error.
NO_ISSUES - Return only documents with zero issues and no document errors.

Available options:

ALL,

WITH_ISSUES,

NO_ISSUES

labels

string

Comma-separated list of label names. Documents with any of the specified labels are included.

folder_paths

string

An array of folder paths to restrict validation to. Paths are prefix-matched, so /Finance also matches /Finance/Reports.

Documents that aren't in a folder are excluded unless you include an empty string ("") in the array.

Example:

"[\"/Finance\",\"/Marketing\"]"

creator_id

string<uuid>

Return only documents created by this user. This value is the membership ID, not the user ID. Use the List users endpoint to retrieve membership IDs.

Response

Content validation results

model_id

string<uuid>

The ID of the model that was validated.

branch

object | null

Branch information if a branch was specified, null otherwise.

Show child attributes

content

object[]

List of documents with their validation results.

Show child attributes

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Validate content

Authorizations

Path Parameters

Query Parameters

Response