Skip to main content
GET
/
v1
/
models
/
{modelId}
/
content-validator
Validate content
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/content-validator \
  --header 'Authorization: Bearer <token>'
{
  "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

Response

Content validation results

​
model_id
string<uuid>

The ID of the model that was validated.

​
branch
object

Branch information if a branch was specified, null otherwise.

​
content
object[]

List of documents with their validation results.