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

# Create a native report share

> Publish the exact saved report identity through the native shared report pipeline. Delegated user OAuth only; requires reports:publish, native publish permission and independent Data access. UUID retries preserve one atomic publication and do not publish later edits. An unlisted link is available to anyone who has it. Snapshot delivery; no Data execution or PDF generation. Requires a delegated MCP user connection; workspace API keys cannot impersonate a publishing user.

Required scopes: `reports:publish`.


## OpenAPI

````yaml POST /api/v2/reports/{reportId}/shares
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}/shares:
    post:
      tags:
        - Reports
      summary: Create a native report share
      description: >-
        Publish the exact saved report identity through the native shared report
        pipeline. Delegated user OAuth only; requires reports:publish, native
        publish permission and independent Data access. UUID retries preserve
        one atomic publication and do not publish later edits. An unlisted link
        is available to anyone who has it. Snapshot delivery; no Data execution
        or PDF generation. Requires a delegated MCP user connection; workspace
        API keys cannot impersonate a publishing user.
      operationId: createReportShare
      parameters:
        - name: reportId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - 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: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportShareRequestV1'
      responses:
        '200':
          description: Native report share.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportShareResponseV1'
        '201':
          description: Native report share.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportShareResponseV1'
        '400':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '503':
          description: Rejected request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - McpConnection: []
components:
  schemas:
    CreateReportShareRequestV1:
      type: object
      properties:
        expectedRevision:
          type: integer
          minimum: 0
        expectedDocumentHash:
          type: string
          pattern: ^[a-f0-9]{64}$
        title:
          type: string
          maxLength: 160
        accessMode:
          type: string
          enum:
            - unlisted
            - workspace_sign_in
            - authenticated_allowlist
            - password
          default: unlisted
        password:
          type: string
          minLength: 10
          maxLength: 128
        allowedUserIds:
          type: array
          items:
            type: integer
            exclusiveMinimum: 0
          maxItems: 250
        allowedPageIds:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 256
          maxItems: 100
        initialPageId:
          type: string
          minLength: 1
          maxLength: 256
        expiresAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        allowDownloadData:
          type: boolean
          default: false
        allowCopyReport:
          type: boolean
          default: false
        allowExternalLinks:
          type: boolean
          default: true
        watermarkEnabled:
          type: boolean
          default: true
        branding:
          type: string
          enum:
            - chatobserver
            - workspace_allowed
          default: chatobserver
      required:
        - expectedRevision
        - expectedDocumentHash
      additionalProperties: false
    ReportShareResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            reportId:
              type: string
              format: uuid
            url:
              type: string
              format: uri
            accessMode:
              type: string
              enum:
                - unlisted
                - workspace_sign_in
                - authenticated_allowlist
                - password
            artifactVersion:
              type: integer
              exclusiveMinimum: 0
            expiresAt:
              anyOf:
                - type: string
                  format: date-time
                - type: 'null'
            revoked:
              type: boolean
          required:
            - id
            - reportId
            - url
            - accessMode
            - artifactVersion
            - expiresAt
            - revoked
          additionalProperties: false
        replayed:
          type: boolean
      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.