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

# Compare private document and existing shared artifact identities

> 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/{reportId}/publication-state
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/{reportId}/publication-state:
    get:
      tags:
        - Reports
      summary: Compare private document and existing shared artifact identities
      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: getReportPublicationState
      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: reportId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: revision
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
        - name: documentHash
          in: query
          required: false
          schema:
            type: string
            pattern: ^[a-f0-9]{64}$
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 4096
      responses:
        '200':
          description: Reviewed result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportPublicationStateResponseV1'
        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:
    ReportPublicationStateResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            identity:
              type: object
              properties:
                reportId:
                  type: string
                  format: uuid
                revision:
                  type: integer
                  minimum: 0
                documentHash:
                  type: string
                  pattern: ^[a-f0-9]{64}$
                nativeDocumentVersion:
                  type: number
                  enum:
                    - 3
                    - 4
              required:
                - reportId
                - revision
                - documentHash
                - nativeDocumentVersion
              additionalProperties: false
            publications:
              type: array
              items:
                type: object
                properties:
                  sharedReportId:
                    type: string
                    format: uuid
                  artifactId:
                    anyOf:
                      - type: string
                        format: uuid
                      - type: 'null'
                  artifactVersion:
                    type: integer
                    exclusiveMinimum: 0
                  state:
                    type: string
                    enum:
                      - active
                      - expired
                      - revoked
                  metadataStatus:
                    type: string
                    enum:
                      - native_identity
                      - unverified_legacy
                      - missing_artifact
                      - invalid_manifest
                      - source_version_unavailable
                  source:
                    anyOf:
                      - type: object
                        properties:
                          revision:
                            type: integer
                            minimum: 0
                          documentHash:
                            type: string
                            pattern: ^[a-f0-9]{64}$
                          nativeDocumentVersion:
                            type: number
                            enum:
                              - 3
                              - 4
                          sourceReportVersionId:
                            anyOf:
                              - type: string
                                format: uuid
                              - type: 'null'
                        required:
                          - revision
                          - documentHash
                          - nativeDocumentVersion
                          - sourceReportVersionId
                        additionalProperties: false
                      - type: 'null'
                  documentFreshness:
                    type: string
                    enum:
                      - same_identity
                      - different_identity
                      - unknown
                  dataFreshness:
                    type: string
                    enum:
                      - same_current_identity
                      - different_or_stale_identity
                      - not_applicable
                      - unknown
                  payloadIntegrity:
                    type: string
                    const: not_assessed
                  generatedAt:
                    type: string
                    format: date-time
                  expiresAt:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                required:
                  - sharedReportId
                  - artifactId
                  - artifactVersion
                  - state
                  - metadataStatus
                  - source
                  - documentFreshness
                  - dataFreshness
                  - payloadIntegrity
                  - generatedAt
                  - expiresAt
                additionalProperties: false
              maxItems: 100
            pageInfo:
              type: object
              properties:
                nextCursor:
                  anyOf:
                    - type: string
                      maxLength: 4096
                    - type: 'null'
                hasMore:
                  type: boolean
              required:
                - nextCursor
                - hasMore
              additionalProperties: false
          required:
            - identity
            - publications
            - pageInfo
          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.