Clarity · Schema

AdminSearchRequest

AICustomer ExperienceCXAgenticEnterprise

Properties

Name Type Description
original_query object
search_query object
original_search_query object
corrected_query object
translated_query object
custom_prompt_begin object
custom_prompt_end object
main_field object
additional_fields object
task object
is_question object
filters array
sorted_by array
deep_search object
calculate_nps boolean
calculate_percent_of_total boolean
question object
taxonomy_element_name object
sentiment object
description object
limit object
offset object
post_filtering object
chat_history array
trend_filters object
distribution_filters object
stacking_filters object
force_refresh boolean
use_external_urls object
search_subquery object
calculate_trend boolean
trend_on string
trend_by string
calculate_distribution boolean
distribution_of string
distribution_by string
calculate_count boolean
count_by string
source object
source_includes object
source_excludes object
min_score number
use_analyzers boolean
do_spellcheck boolean
do_translate boolean
do_filters_extraction boolean
do_intent_analysis boolean
summarize boolean
model object
skip_cache boolean
View JSON Schema on GitHub

JSON Schema

onclarity-com-src-routers-admin-admin-search-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json",
  "title": "AdminSearchRequest",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/onclarity-com-openapi.json#/components/schemas/src__routers__admin__AdminSearchRequest",
  "properties": {
    "original_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original Query"
    },
    "search_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Search Query",
      "default": ""
    },
    "original_search_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original Search Query"
    },
    "corrected_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Corrected Query"
    },
    "translated_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Translated Query"
    },
    "custom_prompt_begin": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom Prompt Begin"
    },
    "custom_prompt_end": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom Prompt End"
    },
    "main_field": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Main Field"
    },
    "additional_fields": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Additional Fields",
      "default": []
    },
    "task": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Task",
      "default": "summarize"
    },
    "is_question": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Question",
      "default": false
    },
    "filters": {
      "items": {
        "$ref": "#/$defs/QueryFilter"
      },
      "type": "array",
      "title": "Filters"
    },
    "sorted_by": {
      "items": {
        "$ref": "#/$defs/QuerySort"
      },
      "type": "array",
      "title": "Sorted By",
      "default": []
    },
    "deep_search": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deep Search",
      "default": false
    },
    "calculate_nps": {
      "type": "boolean",
      "title": "Calculate Nps",
      "default": false
    },
    "calculate_percent_of_total": {
      "type": "boolean",
      "title": "Calculate Percent Of Total",
      "default": false
    },
    "question": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Question"
    },
    "taxonomy_element_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Taxonomy Element Name"
    },
    "sentiment": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sentiment"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "limit": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Limit",
      "default": 9999
    },
    "offset": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Offset",
      "default": 0
    },
    "post_filtering": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Post Filtering",
      "default": true
    },
    "chat_history": {
      "items": {
        "$ref": "#/$defs/ChatHistoryItem"
      },
      "type": "array",
      "title": "Chat History",
      "default": []
    },
    "trend_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "distribution_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "stacking_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "force_refresh": {
      "type": "boolean",
      "title": "Force Refresh",
      "default": false
    },
    "use_external_urls": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Use External Urls",
      "default": false
    },
    "search_subquery": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Search Subquery"
    },
    "calculate_trend": {
      "type": "boolean",
      "title": "Calculate Trend",
      "default": false
    },
    "trend_on": {
      "type": "string",
      "title": "Trend On",
      "default": "volume"
    },
    "trend_by": {
      "type": "string",
      "title": "Trend By",
      "default": "-"
    },
    "calculate_distribution": {
      "type": "boolean",
      "title": "Calculate Distribution",
      "default": false
    },
    "distribution_of": {
      "type": "string",
      "title": "Distribution Of",
      "default": "volume"
    },
    "distribution_by": {
      "type": "string",
      "title": "Distribution By",
      "default": "-"
    },
    "calculate_count": {
      "type": "boolean",
      "title": "Calculate Count",
      "default": false
    },
    "count_by": {
      "type": "string",
      "title": "Count By",
      "default": "-"
    },
    "source": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source"
    },
    "source_includes": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Includes"
    },
    "source_excludes": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source Excludes"
    },
    "min_score": {
      "type": "number",
      "title": "Min Score",
      "default": 1.0
    },
    "use_analyzers": {
      "type": "boolean",
      "title": "Use Analyzers",
      "default": true
    },
    "do_spellcheck": {
      "type": "boolean",
      "title": "Do Spellcheck",
      "default": true
    },
    "do_translate": {
      "type": "boolean",
      "title": "Do Translate",
      "default": true
    },
    "do_filters_extraction": {
      "type": "boolean",
      "title": "Do Filters Extraction",
      "default": true
    },
    "do_intent_analysis": {
      "type": "boolean",
      "title": "Do Intent Analysis",
      "default": true
    },
    "summarize": {
      "type": "boolean",
      "title": "Summarize",
      "default": false
    },
    "model": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Model"
    },
    "skip_cache": {
      "type": "boolean",
      "title": "Skip Cache",
      "default": false
    }
  },
  "type": "object",
  "$defs": {
    "ChatHistoryItem": {
      "properties": {
        "role": {
          "type": "string",
          "pattern": "^(assistant|user)$",
          "title": "Role"
        },
        "content": {
          "type": "string",
          "title": "Content"
        }
      },
      "type": "object",
      "required": [
        "role",
        "content"
      ],
      "title": "ChatHistoryItem"
    },
    "ExtraFilters": {
      "properties": {
        "include_filters": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Include Filters"
        },
        "exclude_filters": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "title": "Exclude Filters"
        },
        "size": {
          "type": "integer",
          "title": "Size",
          "default": 10240
        }
      },
      "type": "object",
      "title": "ExtraFilters"
    },
    "QueryFilter": {
      "properties": {
        "type": {
          "anyOf": [
            {
              "type": "string",
              "const": "exists"
            },
            {
              "type": "string",
              "const": "list"
            },
            {
              "type": "string",
              "const": "nested"
            },
            {
              "type": "string",
              "const": "range"
            },
            {
              "type": "string",
              "const": "text"
            }
          ],
          "title": "Type"
        },
        "key": {
          "type": "string",
          "title": "Key"
        },
        "values": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            {
              "items": {
                "additionalProperties": true,
                "type": "object"
              },
              "type": "array"
            },
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Values"
        },
        "min": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Min"
        },
        "max": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Max"
        },
        "operator": {
          "anyOf": [
            {
              "type": "string",
              "const": "eq"
            },
            {
              "type": "string",
              "const": "neq"
            },
            {
              "type": "string",
              "const": "contains"
            }
          ],
          "title": "Operator",
          "default": "eq"
        },
        "generated": {
          "type": "boolean",
          "title": "Generated",
          "default": false
        }
      },
      "type": "object",
      "required": [
        "type",
        "key"
      ],
      "title": "QueryFilter"
    },
    "QuerySort": {
      "properties": {
        "key": {
          "type": "string",
          "title": "Key"
        },
        "order": {
          "anyOf": [
            {
              "type": "string",
              "const": "asc"
            },
            {
              "type": "string",
              "const": "desc"
            }
          ],
          "title": "Order",
          "default": "asc"
        }
      },
      "type": "object",
      "required": [
        "key"
      ],
      "title": "QuerySort"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/onclarity-com-src-routers-admin-admin-search-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.