> ## 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 complete native page elements and optional surface provenance

> 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}/pages/{pageId}
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}/pages/{pageId}:
    get:
      tags:
        - Reports
      summary: Read complete native page elements and optional surface provenance
      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: getNativeReportPage
      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: pageId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 256
        - name: revision
          in: query
          required: true
          schema:
            type: integer
            minimum: 0
        - name: documentHash
          in: query
          required: true
          schema:
            type: string
            pattern: ^[a-f0-9]{64}$
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 4096
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
        - name: include
          in: query
          required: false
          schema:
            type: string
            enum:
              - effectiveConfiguration
      responses:
        '200':
          description: Reviewed result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNativePageResponseV1'
        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:
    ReportNativePageResponseV1:
      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
            records:
              type: array
              items:
                type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - page
                      - configuration
                      - element
                      - effective_configuration
                      - data_source
                  id:
                    type: string
                    minLength: 1
                    maxLength: 256
                  schemaId:
                    type: string
                    minLength: 1
                    maxLength: 128
                  valueHash:
                    type: string
                    pattern: ^[a-f0-9]{64}$
                  encoding:
                    type: string
                    const: json
                  chunkIndex:
                    type: integer
                    minimum: 0
                  chunkCount:
                    type: integer
                    exclusiveMinimum: 0
                  json:
                    type: string
                    maxLength: 65536
                required:
                  - kind
                  - id
                  - schemaId
                  - valueHash
                  - encoding
                  - chunkIndex
                  - chunkCount
                  - json
                additionalProperties: false
              maxItems: 100
            pageInfo:
              type: object
              properties:
                totalRecords:
                  type: integer
                  minimum: 0
                nextCursor:
                  anyOf:
                    - type: string
                      maxLength: 4096
                    - type: 'null'
                hasMore:
                  type: boolean
              required:
                - totalRecords
                - nextCursor
                - hasMore
              additionalProperties: false
            page:
              anyOf:
                - type: object
                  properties:
                    id:
                      type: string
                      minLength: 1
                      maxLength: 256
                    title:
                      type: string
                      maxLength: 512
                    position:
                      type: integer
                      minimum: 0
                    navigationVisible:
                      type: boolean
                    hidden:
                      type: boolean
                    background:
                      anyOf:
                        - anyOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: solid
                                value:
                                  type: string
                                  minLength: 1
                                  maxLength: 128
                                alpha:
                                  type: number
                                  minimum: 0
                                  maximum: 1
                              required:
                                - kind
                                - value
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: linear_gradient
                                angle:
                                  type: number
                                  minimum: -360
                                  maximum: 360
                                stops:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      offset:
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                      color: f40ac7af-e713-4aaf-93e1-745ba5ab6d84
                                      alpha:
                                        type: number
                                        minimum: 0
                                        maximum: 1
                                    required:
                                      - offset
                                      - color
                                    additionalProperties: false
                                  minItems: 2
                                  maxItems: 16
                              required:
                                - kind
                                - angle
                                - stops
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  const: radial_gradient
                                stops:
                                  type: array
                                  items: 0ad5d3ec-25d7-4580-9b7d-0b438fa19f0d
                                  minItems: 2
                                  maxItems: 16
                              required:
                                - kind
                                - stops
                              additionalProperties: false
                        - type: 'null'
                    rootElementIds:
                      type: array
                      items: edef3069-cd92-41d1-a1b9-cb0024c27357
                      maxItems: 250
                    fixed:
                      anyOf:
                        - type: object
                          properties:
                            width:
                              type: number
                              exclusiveMinimum: 0
                              minimum: 320
                              maximum: 10000
                            minimumHeight:
                              type: number
                              exclusiveMinimum: 0
                              minimum: 240
                              maximum: 20000
                            heightMode:
                              type: string
                              enum:
                                - explicit
                                - auto_extend
                            explicitHeight:
                              anyOf:
                                - type: number
                                  exclusiveMinimum: 0
                                  minimum: 240
                                  maximum: 20000
                                - type: 'null'
                            margins:
                              type: object
                              properties:
                                top:
                                  type: number
                                  minimum: 0
                                  maximum: 320
                                right:
                                  type: number
                                  minimum: 0
                                  maximum: 320
                                bottom:
                                  type: number
                                  minimum: 0
                                  maximum: 320
                                left:
                                  type: number
                                  minimum: 0
                                  maximum: 320
                              required:
                                - top
                                - right
                                - bottom
                                - left
                              additionalProperties: false
                            bleed:
                              type: number
                              minimum: 0
                              maximum: 320
                            masterRegionElementIds:
                              type: array
                              items: 83c6ee20-859b-4f82-8db8-5117e3da29a8
                              maxItems: 32
                            gridSize:
                              type: number
                              enum:
                                - 4
                                - 8
                                - 10
                                - 20
                              default: 20
                            guides:
                              type: array
                              items:
                                type: object
                                properties:
                                  id: 9e482465-2051-4755-b3d1-e9ed69607340
                                  axis:
                                    type: string
                                    enum:
                                      - x
                                      - 'y'
                                  position:
                                    type: number
                                    minimum: 0
                                required:
                                  - id
                                  - axis
                                  - position
                                additionalProperties: false
                              maxItems: 100
                              default: []
                          required:
                            - width
                            - minimumHeight
                            - heightMode
                            - explicitHeight
                            - margins
                            - bleed
                            - masterRegionElementIds
                          additionalProperties: false
                        - type: 'null'
                    responsive:
                      anyOf:
                        - type: object
                          properties:
                            sectionIds:
                              type: array
                              items: edef3069-cd92-41d1-a1b9-cb0024c27357
                              maxItems: 250
                            contentMaxWidth:
                              anyOf:
                                - type: number
                                  exclusiveMinimum: 0
                                  maximum: 10000
                                - type: 'null'
                            outerPadding:
                              type: number
                              minimum: 0
                              maximum: 320
                            gap:
                              type: number
                              minimum: 0
                              maximum: 320
                            breakpointOverrides:
                              type: object
                              properties:
                                desktop:
                                  type: object
                                  properties:
                                    contentMaxWidth:
                                      anyOf:
                                        - type: number
                                          exclusiveMinimum: 0
                                          maximum: 10000
                                        - type: 'null'
                                    outerPadding:
                                      type: number
                                      minimum: 0
                                      maximum: 320
                                    gap:
                                      type: number
                                      minimum: 0
                                      maximum: 320
                                  additionalProperties: false
                                tablet: 1447bbf1-d35e-4418-82a7-2cc171ad11b9
                                mobile: dda4a248-8169-49c2-9ade-3048aa729a58
                              additionalProperties: false
                            printGrouping:
                              type: string
                              enum:
                                - preserve_sections
                                - allow_split
                          required:
                            - sectionIds
                            - contentMaxWidth
                            - outerPadding
                            - gap
                            - breakpointOverrides
                            - printGrouping
                          additionalProperties: false
                        - type: 'null'
                  required:
                    - id
                    - title
                    - position
                    - navigationVisible
                    - background
                    - rootElementIds
                    - fixed
                    - responsive
                  additionalProperties: false
                - type: 'null'
            pageId:
              type: string
              maxLength: 256
            pageInRecords:
              type: boolean
            pageHash:
              type: string
              pattern: ^[a-f0-9]{64}$
            effectiveConfigurationIncluded:
              type: boolean
          required:
            - identity
            - records
            - pageInfo
            - page
            - pageId
            - pageInRecords
            - pageHash
            - effectiveConfigurationIncluded
          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.