> ## 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.

# Discover native assessment targets, contexts and profiles

> 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/canvas/capabilities
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/canvas/capabilities:
    get:
      tags:
        - Reports
      summary: Discover native assessment targets, contexts and profiles
      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: getCanvasCapabilities
      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.
      responses:
        '200':
          description: Reviewed result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanvasCapabilitiesResponseV1'
        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:
    CanvasCapabilitiesResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            version:
              type: number
              const: 1
            targetKinds:
              type: array
              items:
                type: string
                const: saved_revision
              minItems: 1
              maxItems: 1
            layoutModes:
              type: array
              items:
                type: string
                enum:
                  - fixed
                  - responsive
              minItems: 2
              maxItems: 2
            nativeDocumentVersion:
              type: number
              enum:
                - 3
                - 4
            nativeDocumentVersions:
              type: array
              items:
                type: number
                enum:
                  - 3
                  - 4
              maxItems: 2
            elementProbes:
              type: array
              items:
                type: object
                properties:
                  typeId:
                    type: string
                    minLength: 1
                    maxLength: 256
                  elementVersion:
                    type: integer
                    exclusiveMinimum: 0
                  family:
                    type: string
                    enum:
                      - text
                      - scorecard
                      - chart
                      - table
                      - image
                      - control
                      - container
                      - decoration
                      - content
                      - unsupported
                  support:
                    type: string
                    enum:
                      - conditional
                      - unsupported
                  requiredEvidence:
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 256
                    maxItems: 64
                  conditions:
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 2000
                    minItems: 1
                    maxItems: 16
                required:
                  - typeId
                  - elementVersion
                  - family
                  - support
                  - requiredEvidence
                  - conditions
                additionalProperties: false
              maxItems: 64
            profiles:
              type: object
              additionalProperties:
                type: object
                properties:
                  id:
                    type: string
                  version:
                    type: number
                    const: 1
                  requireContrast:
                    type: boolean
                required:
                  - id
                  - version
                  - requireContrast
                additionalProperties: false
            locales:
              type: array
              items:
                type: string
                maxLength: 32
              minItems: 1
              maxItems: 32
            limits:
              type: object
              properties:
                contextsPerJob:
                  type: integer
                  minimum: 0
                pageContextsPerJob: 18ab459f-e47a-46cb-aa4d-b9561dd653d6
                maxSnapshotBytes: 809fa6f9-51f1-4bee-919f-4a532fd571ca
                maxMeasurementBytes: 2287b47f-12fa-40c2-96a3-838f387d9577
                maxDomNodesPerContext: 931f5d4d-fa68-4a8f-b9e1-6f22d253f93c
                maxFindingsPerAssessment: 934689a8-c959-461b-9ace-4a3205861704
              required:
                - contextsPerJob
                - pageContextsPerJob
                - maxSnapshotBytes
                - maxMeasurementBytes
                - maxDomNodesPerContext
                - maxFindingsPerAssessment
              additionalProperties: false
            instructions:
              type: string
              maxLength: 20000
            reportWrites:
              type: boolean
              const: false
            dataPolicy:
              type: string
              maxLength: 2000
            screenshots:
              type: boolean
              const: false
          required:
            - version
            - targetKinds
            - layoutModes
            - nativeDocumentVersion
            - elementProbes
            - profiles
            - locales
            - limits
            - instructions
            - reportWrites
            - dataPolicy
            - screenshots
          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.