> ## Documentation Index
> Fetch the complete documentation index at: https://chatobserver.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Read one versioned native configuration schema

> Requires user-authorized Chatobserver MCP consent, reports:read, current native membership and report access, and workspace feature availability. Workspace service keys are unsupported. Cached report outputs additionally require independent Data access and data:read consent. Report discovery and assessment do not run queries, refresh Data, edit reports or publish shares. Unknown or unsupported evidence is not a pass.

Required scopes: `reports:read`.


## OpenAPI

````yaml GET /api/v2/reports/capabilities/{schemaId}
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
  - name: Tracked coverage
    description: >-
      Track published coverage, maintain its metadata and inspect exact-page
      citation evidence with the same workspace feature access as the dashboard.
  - name: Reports
    description: >-
      Discover accessible native reports and assess exact saved revisions using
      measured, context-specific evidence.
paths:
  /api/v2/reports/capabilities/{schemaId}:
    get:
      tags:
        - Reports
      summary: Read one versioned native configuration schema
      description: >-
        Requires user-authorized Chatobserver MCP consent, reports:read, current
        native membership and report access, and workspace feature availability.
        Workspace service keys are unsupported. Cached report outputs
        additionally require independent Data access and data:read consent.
        Report discovery and assessment do not run queries, refresh Data, edit
        reports or publish shares. Unknown or unsupported evidence is not a
        pass.
      operationId: getReportCapabilitySchema
      parameters:
        - name: x-workspace-id
          in: header
          required: true
          schema:
            type: string
            pattern: ^ws_[a-f0-9]{32}$
          description: Explicit workspace selected for the delegated account.
        - name: schemaId
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
      responses:
        '200':
          description: Reviewed result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCapabilitySchemaResponseV1'
        default:
          description: >-
            Authentication, changed inputs, unsupported target, incomplete
            assessment or unavailable dispatcher. Preserve the UUID idempotency
            key on uncertain retries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - McpConnection: []
components:
  schemas:
    ReportCapabilitySchemaResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            version:
              type: number
              const: 1
            family:
              type: string
              enum:
                - element
                - theme
                - style
                - layout
                - text
                - control
                - semantic
                - interaction
                - print
                - viewer
                - data_binding
                - policy
                - operation
            typeId:
              anyOf:
                - type: string
                  minLength: 1
                  maxLength: 256
                - type: 'null'
            nativeVersion:
              type: integer
              exclusiveMinimum: 0
            schemaHash:
              type: string
              pattern: ^[a-f0-9]{64}$
            layoutModes:
              type: array
              items:
                type: string
                enum:
                  - fixed
                  - responsive
              minItems: 1
              maxItems: 2
            authoringStatus:
              type: string
              const: contract_only
            conditions:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 2000
              maxItems: 16
            schema:
              type: object
              properties:
                $ref: 849e0957-6dce-4930-b9d5-6cb2b97b2539
                $id:
                  type: string
                type:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                title:
                  type: string
                description:
                  type: string
                properties:
                  type: object
                  additionalProperties: daa455b9-7ab8-4618-a8c8-e3fa102c9054
                propertyNames: 5d6a97a0-81fc-4c3a-8188-2717e02e99a3
                patternProperties:
                  type: object
                  additionalProperties: daa455b9-7ab8-4618-a8c8-e3fa102c9054
                definitions:
                  type: object
                  additionalProperties: daa455b9-7ab8-4618-a8c8-e3fa102c9054
                $defs:
                  type: object
                  additionalProperties: daa455b9-7ab8-4618-a8c8-e3fa102c9054
                required:
                  type: array
                  items:
                    type: string
                additionalProperties:
                  anyOf:
                    - type: boolean
                    - bf92203e-b4ea-40ff-a0df-69b0404203f7
                items:
                  anyOf:
                    - d2391555-195f-4d8b-a497-136496434b8b
                    - type: array
                      items: da358755-f0f0-41e7-85fb-6ee639657026
                anyOf:
                  type: array
                  items: da358755-f0f0-41e7-85fb-6ee639657026
                oneOf:
                  type: array
                  items: da358755-f0f0-41e7-85fb-6ee639657026
                allOf:
                  type: array
                  items: da358755-f0f0-41e7-85fb-6ee639657026
                not: d5f9cdcc-799e-48c1-aefb-d2bb6a4e73c3
                enum:
                  type: array
                  items:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: 'null'
                      - type: array
                        items: 38dd9467-e7a1-4b32-ac72-8592838ba3cc
                      - type: object
                        additionalProperties: bd25de79-0922-42dc-b107-1d502bfb7e10
                const: 2079d69a-c0db-49b0-a4f2-5c3a2fb449ef
                default: b77b9a3c-286b-470a-8d02-620e831ce65a
                examples:
                  type: array
                  items: 38dd9467-e7a1-4b32-ac72-8592838ba3cc
                minimum:
                  type: number
                maximum:
                  type: number
                exclusiveMinimum:
                  type: number
                exclusiveMaximum:
                  type: number
                multipleOf:
                  type: number
                  exclusiveMinimum: 0
                minLength:
                  type: integer
                  minimum: 0
                maxLength: 1db51677-9dfb-400f-a1ff-945279f15040
                pattern:
                  type: string
                format:
                  type: string
                minItems: fc23aef5-538a-4d8e-b479-ee0903ec6b22
                maxItems: 99f0b8bc-a2f9-400e-807f-cda88984fdab
                uniqueItems:
                  type: boolean
                minProperties: ceeeacfd-a504-43ff-a7f5-da18abd167a7
                maxProperties: ce0b4271-ee51-440a-ba3c-ef3976f202b1
                readOnly:
                  type: boolean
                writeOnly:
                  type: boolean
              additionalProperties: false
          required:
            - id
            - version
            - family
            - typeId
            - nativeVersion
            - schemaHash
            - layoutModes
            - authoringStatus
            - conditions
            - schema
          additionalProperties: false
      required:
        - data
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
        requestId:
          type: string
      required:
        - error
        - requestId
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.
    McpConnection:
      type: http
      scheme: bearer
      description: >-
        Delegated application credential issued after Chatobserver account
        consent. Restricted to selected workspaces and explicitly supported MCP
        operations. The MCP server access token is a separate credential and
        cannot be used here.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.