Clarity · Schema

AnalyticsOverviewRequest

Artificial IntelligenceCustomer ExperienceAI AgentsEnterprise

Properties

Name Type Description
scorecard_ids object
agents object
teams object
channels object
team_field string ES field name for team grouping
channel_field string ES field name for channel grouping
agent_field string ES field for agent grouping/filtering
agent_name_field string ES field for agent display name
team_ids_op string
agent_ids_op string
channel_ids_op string
conversation_types object
exclude_kb_unscored object
score_min object
score_max object
has_violation object
has_failed object
has_unverified object
has_incomplete object
needs_review object
has_kb_unscored object
kb_statuses object
violation_types object
project_id integer
date_from string Start date (inclusive), ISO 8601
date_to string End date (inclusive), ISO 8601
configured_metrics object
metric_fields object
search object Case-insensitive partial match on team name
View JSON Schema on GitHub

JSON Schema

onclarity-com-analytics-overview-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-analytics-overview-request-schema.json",
  "title": "AnalyticsOverviewRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/onclarity-com-agent-qa-api-openapi.yml#/components/schemas/AnalyticsOverviewRequest",
  "properties": {
    "scorecard_ids": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 50
        },
        {
          "type": "null"
        }
      ],
      "title": "Scorecard Ids"
    },
    "agents": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array",
          "maxItems": 100
        },
        {
          "type": "null"
        }
      ],
      "title": "Agents"
    },
    "teams": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Teams"
    },
    "channels": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Channels"
    },
    "team_field": {
      "type": "string",
      "title": "Team Field",
      "description": "ES field name for team grouping",
      "default": "team__filter"
    },
    "channel_field": {
      "type": "string",
      "title": "Channel Field",
      "description": "ES field name for channel grouping",
      "default": "channel__filter"
    },
    "agent_field": {
      "type": "string",
      "title": "Agent Field",
      "description": "ES field for agent grouping/filtering",
      "default": "agent_id"
    },
    "agent_name_field": {
      "type": "string",
      "title": "Agent Name Field",
      "description": "ES field for agent display name",
      "default": "agent_name__filter"
    },
    "team_ids_op": {
      "type": "string",
      "enum": [
        "is",
        "is_not"
      ],
      "title": "Team Ids Op",
      "default": "is"
    },
    "agent_ids_op": {
      "type": "string",
      "enum": [
        "is",
        "is_not"
      ],
      "title": "Agent Ids Op",
      "default": "is"
    },
    "channel_ids_op": {
      "type": "string",
      "enum": [
        "is",
        "is_not"
      ],
      "title": "Channel Ids Op",
      "default": "is"
    },
    "conversation_types": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Conversation Types"
    },
    "exclude_kb_unscored": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Exclude Kb Unscored"
    },
    "score_min": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 100.0,
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Score Min"
    },
    "score_max": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 100.0,
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Score Max"
    },
    "has_violation": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Has Violation"
    },
    "has_failed": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Has Failed"
    },
    "has_unverified": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Has Unverified"
    },
    "has_incomplete": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Has Incomplete"
    },
    "needs_review": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Needs Review"
    },
    "has_kb_unscored": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Has Kb Unscored"
    },
    "kb_statuses": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Kb Statuses"
    },
    "violation_types": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Violation Types"
    },
    "project_id": {
      "type": "integer",
      "title": "Project Id"
    },
    "date_from": {
      "type": "string",
      "title": "Date From",
      "description": "Start date (inclusive), ISO 8601"
    },
    "date_to": {
      "type": "string",
      "title": "Date To",
      "description": "End date (inclusive), ISO 8601"
    },
    "configured_metrics": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Configured Metrics"
    },
    "metric_fields": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metric Fields"
    },
    "search": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Search",
      "description": "Case-insensitive partial match on team name"
    }
  },
  "type": "object",
  "required": [
    "project_id",
    "date_from",
    "date_to"
  ]
}

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-analytics-overview-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.