Clarity · Schema

UpdateDashboardElementRequest

AICustomer ExperienceCXAgenticEnterprise

Properties

Name Type Description
label string
custom_prompt_begin object
custom_prompt_end object
search_query object
quantify_prompt object
number_of_topics object
additional_fields object
main_field object
text object
filters object
use_external_urls object
distribution_filters object
stacking_filters object
trend_filters object
trend_on object
trend_by object
trend_granulation object
distribution_of object
distribution_by object
stacked_by object
sorted_by object
category_id object
anecdote_id object
taxonomy_key object
deep_search object
task object
original_query object
corrected_query object
translated_query object
segments_data object
kpi_label object
kpi_aggregation object
kpi_baseline object
kpi_delta object
kpi_threshold object
kpi_sparkline object
legend_position object
show_title object
show_legend object
show_controls object
widget_chrome object
accent_color object
rows object
columns object
values object
table_chart object
table_sort object
View JSON Schema on GitHub

JSON Schema

onclarity-com-update-dashboard-element-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json",
  "title": "UpdateDashboardElementRequest",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/onclarity-com-openapi.json#/components/schemas/UpdateDashboardElementRequest",
  "properties": {
    "label": {
      "type": "string",
      "title": "Label"
    },
    "custom_prompt_begin": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom Prompt Begin"
    },
    "custom_prompt_end": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Custom Prompt End"
    },
    "search_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Search Query"
    },
    "quantify_prompt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Quantify Prompt"
    },
    "number_of_topics": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Number Of Topics"
    },
    "additional_fields": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Additional Fields",
      "default": []
    },
    "main_field": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Main Field"
    },
    "text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Text"
    },
    "filters": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Filters"
    },
    "use_external_urls": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Use External Urls",
      "default": false
    },
    "distribution_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "stacking_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "trend_filters": {
      "anyOf": [
        {
          "$ref": "#/$defs/ExtraFilters"
        },
        {
          "type": "null"
        }
      ]
    },
    "trend_on": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Trend On"
    },
    "trend_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Trend By"
    },
    "trend_granulation": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Trend Granulation"
    },
    "distribution_of": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Distribution Of"
    },
    "distribution_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Distribution By"
    },
    "stacked_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Stacked By"
    },
    "sorted_by": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sorted By"
    },
    "category_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Category Id"
    },
    "anecdote_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Anecdote Id"
    },
    "taxonomy_key": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Taxonomy Key"
    },
    "deep_search": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Deep Search"
    },
    "task": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Task"
    },
    "original_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Original Query"
    },
    "corrected_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Corrected Query"
    },
    "translated_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Translated Query"
    },
    "segments_data": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Segments Data"
    },
    "kpi_label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Label"
    },
    "kpi_aggregation": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Aggregation"
    },
    "kpi_baseline": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Baseline"
    },
    "kpi_delta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Delta"
    },
    "kpi_threshold": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Threshold"
    },
    "kpi_sparkline": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kpi Sparkline"
    },
    "legend_position": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Legend Position"
    },
    "show_title": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Show Title"
    },
    "show_legend": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Show Legend"
    },
    "show_controls": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Show Controls"
    },
    "widget_chrome": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Widget Chrome"
    },
    "accent_color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Accent Color"
    },
    "rows": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Rows"
    },
    "columns": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Columns"
    },
    "values": {
      "anyOf": [
        {
          "items": {
            "additionalProperties": true,
            "type": "object"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Values"
    },
    "table_chart": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Table Chart"
    },
    "table_sort": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Table Sort"
    }
  },
  "type": "object",
  "required": [
    "label"
  ],
  "$defs": {
    "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"
    }
  }
}

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-update-dashboard-element-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.