Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Content validator

Find and replace content

Performs find/replace operations on content using the specified model.

This endpoint allows you to replace views or fields across all documents associated with the model. This is useful when renaming model elements and need to update all references.

post/v1/models/{modelId}/content-validator

Path parameters

modelIdstring uuid required

The ID of the model to perform find/replace against.

Query parameters

userIdstring 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.

Request body

findstring required

The value to find. Used with find_or_replace_type to scope the search:

  • VIEW - The name of the view to find
  • FIELD - The fully qualified name of the field to find, specified as view_name.field_name
  • TOPIC - The name of the topic to find
replacementstring required

The replacement value.

  • VIEW - The name of the replacement view
  • FIELD - The fully qualified name of the replacement field, specified as view_name.field_name
  • TOPIC - The name of the replacement topic
find_or_replace_type'VIEW' | 'FIELD' | 'TOPIC' required

The type of find/replace operation.

  • VIEW - Replace view references
  • FIELD - Replace field references. find and replacement values must be the fully qualified name of the field, e.g. view_name.field_name.
  • TOPIC - Replace topic references
branch_idstring uuid

The branch ID to perform the operation on. If not provided, operates on the main model.

include_personal_foldersboolean

When enabled, include personal folders.

only_in_workbook_idstring uuid

When provided, scopes the find/replace action to the specified workbook.

Must be the workbook model's internal UUID — visible in the model IDE URL as /model/{uuid}. This is not the same as the document's URL identifier (slug) that appears in the dashboard or workbook URL (for example, /dashboards/abc123). Passing a document identifier / slug will silently return 0 replacements instead of raising an error.

Example request

{
  "only_in_workbook_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Find/replace operation completed successfully

replaced_queries_countinteger

The number of queries that had replacements made.

replaced_documents_countinteger

The number of documents that had replacements made.

replaced_workbook_models_countinteger

The number of workbook models that had replacements made.

replaced_dashboard_filters_countinteger

The number of dashboard filters that had replacements made.

skipped_pr_required_countinteger

The number of documents skipped because they require a pull request to publish.