> ## 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 the exact report identity and assessment pages > 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} 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}: get: tags: - Reports summary: Read the exact report identity and assessment pages 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: getCanvasReport 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: include in: query required: false schema: type: string enum: - manifest - configuration - 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 responses: '200': description: Reviewed result. content: application/json: schema: $ref: '#/components/schemas/CanvasReportDetailsResponseV1' 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: CanvasReportDetailsResponseV1: type: object properties: data: anyOf: - type: object properties: id: type: string format: uuid name: type: string maxLength: 4096 revision: type: integer minimum: 0 documentHash: anyOf: - type: string pattern: ^[0-9a-f]{64}$ - type: 'null' nativeDocumentVersion: anyOf: - ee129a51-52d3-47aa-84fe-6aaf44915ec4 - type: 'null' updatedAt: type: string format: date-time layoutMode: anyOf: - type: string enum: - fixed - responsive - type: 'null' assessmentSupport: type: string enum: - saved_revision - unsupported_native_document - unsupported_frozen_bundle pages: type: array items: type: object properties: id: type: string maxLength: 256 position: 80be0598-3e5d-4c5d-bb95-850789fa50e7 elementCount: 02d18c66-3704-4efb-99fa-df1d4477f0fb canvasWidth: type: number exclusiveMinimum: 0 required: - id - position - elementCount - canvasWidth additionalProperties: false maxItems: 500 dataSourceCount: c21ca9de-275a-40ba-88f7-15049e3ea66e required: - id - name - revision - documentHash - nativeDocumentVersion - updatedAt - layoutMode - assessmentSupport - pages - dataSourceCount additionalProperties: false - type: object properties: id: 7c2331f0-c26b-4007-aae9-2632bb094993 name: 5ae3457d-ea5b-4f10-8e96-f5b1a53d120d revision: ad846b58-e03e-4678-9a54-f66352cd8237 documentHash: 9f873165-5f3d-4e28-b00c-2934fd8c94e7 nativeDocumentVersion: 95fd0478-cbdb-4165-9613-890449c8d1f2 updatedAt: 025945bc-e9cd-4c2e-870b-c36a70f7caa5 layoutMode: 070e0f8d-3ffc-40e2-88bc-fa43ebcc4544 manifest: 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 configurationSchemaId: type: string maxLength: 128 configurationHash: type: string pattern: ^[a-f0-9]{64}$ pages: type: array items: type: object properties: id: type: string maxLength: 256 pageHash: type: string pattern: ^[a-f0-9]{64}$ elementsHash: type: string pattern: ^[a-f0-9]{64}$ elementCount: type: integer minimum: 0 required: - id - pageHash - elementsHash - elementCount additionalProperties: false maxItems: 500 dataSourceAttachmentIds: type: array items: type: string maxLength: 256 maxItems: 1000 required: - identity - configurationSchemaId - configurationHash - pages - dataSourceAttachmentIds additionalProperties: false required: - id - name - revision - documentHash - nativeDocumentVersion - updatedAt - layoutMode - manifest additionalProperties: false - type: object properties: identity: b4788b8a-074b-4cc2-9a64-f4ce9970cbd0 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 required: - identity - records - 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.