CiteLadder · Schema

PerceptionResponse

Artificial IntelligenceVisibilitySearchCitationsAnalytics

Properties

Name Type Description
state string
reason object
source_audit_ids array
brand object
coverage object
entities array
engines array
topics array
prompts array
themes array
negative_quotes array
drivers array
recommended object
trend array
View JSON Schema on GitHub

JSON Schema

citeladder-com-perception-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/citeladder-com/json-schema/citeladder-com-perception-response-schema.json",
  "title": "PerceptionResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citeladder-com-openapi.json#/components/schemas/PerceptionResponse",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "enum": [
        "value",
        "pending",
        "unavailable",
        "no_mentions"
      ]
    },
    "reason": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "model_not_configured",
            "platform_cap",
            "entity_limit",
            "invalid_output",
            "model_error",
            "task_failed",
            "not_assessable"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "source_audit_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      }
    },
    "brand": {
      "anyOf": [
        {
          "$ref": "#/$defs/PerceptionEntity"
        },
        {
          "type": "null"
        }
      ]
    },
    "coverage": {
      "$ref": "#/$defs/PerceptionCoverage"
    },
    "entities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PerceptionEntity"
      }
    },
    "engines": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PerceptionBreakdown"
      }
    },
    "topics": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PerceptionBreakdown"
      }
    },
    "prompts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PerceptionBreakdown"
      }
    },
    "themes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "theme": {
            "type": "string"
          },
          "positive": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "negative": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "quotes": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/PerceptionQuote"
            }
          }
        },
        "required": [
          "theme",
          "positive",
          "negative",
          "quotes"
        ],
        "additionalProperties": false
      }
    },
    "negative_quotes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PerceptionQuote"
      }
    },
    "drivers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string"
          },
          "answers": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "example_url": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "domain",
          "answers",
          "example_url"
        ],
        "additionalProperties": false
      }
    },
    "recommended": {
      "type": "object",
      "properties": {
        "mentioned": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "recommended": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "recommended_against": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "rate": {
          "type": [
            "number",
            "null"
          ]
        },
        "limitation": {
          "type": "string"
        }
      },
      "required": [
        "mentioned",
        "recommended",
        "recommended_against",
        "rate",
        "limitation"
      ],
      "additionalProperties": false
    },
    "trend": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "audit_id": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "completed_at": {
            "type": "string"
          },
          "score": {
            "$ref": "#/$defs/PerceptionScore"
          },
          "mentions": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "extractor_version": {
            "type": "string"
          },
          "template_version": {
            "type": "string"
          },
          "metrics_version": {
            "type": "string"
          },
          "comparable": {
            "type": "boolean"
          }
        },
        "required": [
          "audit_id",
          "completed_at",
          "score",
          "mentions",
          "extractor_version",
          "template_version",
          "metrics_version",
          "comparable"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "state",
    "reason",
    "source_audit_ids",
    "brand",
    "coverage",
    "entities",
    "engines",
    "topics",
    "prompts",
    "themes",
    "negative_quotes",
    "drivers",
    "recommended",
    "trend"
  ],
  "additionalProperties": false,
  "$defs": {
    "PerceptionBreakdown": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "score": {
          "$ref": "#/$defs/PerceptionScore"
        },
        "coverage": {
          "$ref": "#/$defs/PerceptionCoverage"
        }
      },
      "required": [
        "key",
        "label",
        "score",
        "coverage"
      ],
      "additionalProperties": false
    },
    "PerceptionCoverage": {
      "type": "object",
      "properties": {
        "mentions": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "classified": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "pending": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "not_assessable": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "low_confidence": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "unavailable": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "reason": {
                "type": "string",
                "enum": [
                  "model_not_configured",
                  "platform_cap",
                  "entity_limit",
                  "invalid_output",
                  "model_error",
                  "task_failed",
                  "not_assessable"
                ]
              },
              "count": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "reason",
              "count"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "mentions",
        "classified",
        "pending",
        "not_assessable",
        "low_confidence",
        "unavailable"
      ],
      "additionalProperties": false
    },
    "PerceptionEntity": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "is_brand": {
          "type": "boolean"
        },
        "score": {
          "$ref": "#/$defs/PerceptionScore"
        },
        "coverage": {
          "$ref": "#/$defs/PerceptionCoverage"
        }
      },
      "required": [
        "name",
        "is_brand",
        "score",
        "coverage"
      ],
      "additionalProperties": false
    },
    "PerceptionQuote": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "theme": {
          "type": "string"
        },
        "polarity": {
          "type": "string",
          "enum": [
            "positive",
            "negative"
          ]
        },
        "entity": {
          "type": "string"
        },
        "is_brand": {
          "type": "boolean"
        },
        "logical_engine": {
          "type": "string"
        },
        "prompt": {
          "type": "string"
        },
        "run_id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "execution_id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "observed_at": {
          "type": "string"
        },
        "extractor_version": {
          "type": "string"
        },
        "template_version": {
          "type": "string"
        }
      },
      "required": [
        "text",
        "theme",
        "polarity",
        "entity",
        "is_brand",
        "logical_engine",
        "prompt",
        "run_id",
        "execution_id",
        "observed_at",
        "extractor_version",
        "template_version"
      ],
      "additionalProperties": false
    },
    "PerceptionScore": {
      "type": "object",
      "properties": {
        "positive": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "neutral": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "negative": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "mixed": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "classified": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "positive_share": {
          "type": [
            "number",
            "null"
          ]
        },
        "negative_share": {
          "type": [
            "number",
            "null"
          ]
        },
        "net_sentiment": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "positive",
        "neutral",
        "negative",
        "mixed",
        "classified",
        "positive_share",
        "negative_share",
        "net_sentiment"
      ],
      "additionalProperties": false
    }
  }
}

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/citeladder-com-perception-response"
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.