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

# Save native report edits using a revision

> Atomically save typed native operations in freeform or responsive mode. Semantic regions compile into editable native placements; preserve retains complete authored geometry. Requires reports:write and current native edit permission. Data attachments remain report-owned and require independent Data access. No stage, hashes, renderer job, assessment or measured-plan commit is required. The result explicitly remains not_assessed. Does not execute Data or publish. Reuse the same UUID Idempotency-Key and complete command on uncertain retries. Plain text can use {kind: "append_text", id: "text-1", text: "your text"}; the server supplies native defaults, first-page membership and desktop composition in fixed or responsive mode. Optional pageId, regionId and textStyle select a destination and text role. Full native operations remain supported. OPTIONS returns public protocol support in Chatobserver-Report-Save-Commands without reading any report.

Required scopes: `reports:write`.


## OpenAPI

````yaml POST /api/v2/reports/{reportId}/save
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.
  - name: SEO
    description: >-
      Use authorized workspace SEO tools through the stateless MCP endpoint.
      Availability follows native workspace access and rollout controls; paid
      tools require a separately configured SEO allowance and spending
      admission. OpenSEO AI visibility tools remain unavailable.
paths:
  /api/v2/reports/{reportId}/save:
    post:
      tags:
        - Reports
      summary: Save native report edits using a revision
      description: >-
        Atomically save typed native operations in freeform or responsive mode.
        Semantic regions compile into editable native placements; preserve
        retains complete authored geometry. Requires reports:write and current
        native edit permission. Data attachments remain report-owned and require
        independent Data access. No stage, hashes, renderer job, assessment or
        measured-plan commit is required. The result explicitly remains
        not_assessed. Does not execute Data or publish. Reuse the same UUID
        Idempotency-Key and complete command on uncertain retries. Plain text
        can use {kind: "append_text", id: "text-1", text: "your text"}; the
        server supplies native defaults, first-page membership and desktop
        composition in fixed or responsive mode. Optional pageId, regionId and
        textStyle select a destination and text role. Full native operations
        remain supported. OPTIONS returns public protocol support in
        Chatobserver-Report-Save-Commands without reading any report.
      operationId: saveNativeReport
      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: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportSaveRequestV1'
      responses:
        '200':
          description: Saved revision or identical retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSaveResponseV1'
        default:
          description: Invalid configuration, permission denied or revision conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - McpConnection: []
        - WorkspaceKey: []
components:
  schemas:
    ReportSaveRequestV1:
      type: object
      properties:
        expectedRevision:
          type: integer
          minimum: 0
        layoutPolicy:
          type: string
          enum:
            - compose
            - preserve
          default: compose
        allowPageGrowth:
          type: boolean
          default: true
        operations:
          type: array
          minItems: 1
          maxItems: 256
          items:
            anyOf:
              - $ref: '#/components/schemas/ReportAppendTextCommandV1'
              - 60e9250c-d0af-4c3e-97a0-ad914306f358
      required:
        - expectedRevision
        - operations
      additionalProperties: false
    ReportSaveResponseV1:
      type: object
      properties:
        data:
          type: object
          properties:
            reportId:
              type: string
              format: uuid
            revision:
              type: integer
              minimum: 0
            operationId:
              type: string
              format: uuid
            assessment:
              type: string
              const: not_assessed
          required:
            - reportId
            - revision
            - operationId
            - assessment
          additionalProperties: false
        replayed:
          type: boolean
      required:
        - data
        - replayed
      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
    ReportAppendTextCommandV1:
      type: object
      properties:
        kind:
          type: string
          const: append_text
        id:
          type: string
          minLength: 1
          maxLength: 256
          description: A new, stable element identity, for example text-1.
        text:
          type: string
          maxLength: 100000
          description: The exact visible plain text.
        pageId:
          $ref: 83dd956f-d5b7-4492-916d-73560900e641
          description: Defaults to the first logical page.
        regionId:
          $ref: b7f1ba0b-e428-48fd-9079-205eadb37792
          description: >-
            Optional existing composition region. Omit for a new empty page or
            an unambiguous body column.
        textStyle:
          type: string
          enum:
            - paragraph
            - h1
            - h2
            - h3
            - quote
            - code
          default: paragraph
      required:
        - kind
        - id
        - text
      additionalProperties: false
  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.