> ## 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. # Assess an exact saved report revision > 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 POST /api/v2/reports/{reportId}/assessments 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}/assessments: post: tags: - Reports summary: Assess an exact saved report revision 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: postCanvasAssessment 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/CanvasSavedAssessmentRequestV1' responses: '200': description: Identical idempotent replay. content: application/json: schema: $ref: '#/components/schemas/CanvasJobResponseV1' '202': description: Derived assessment admitted; poll the job. content: application/json: schema: $ref: '#/components/schemas/CanvasJobResponseV1' 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: CanvasSavedAssessmentRequestV1: type: object properties: target: type: object properties: kind: type: string const: saved_revision reportId: type: string format: uuid revision: type: integer minimum: 0 expectedDocumentHash: type: string pattern: ^[0-9a-f]{64}$ required: - kind - reportId - revision - expectedDocumentHash additionalProperties: false profile: type: object properties: id: type: string enum: - report-standard-v1 - report-accessible-v1 version: type: number const: 1 required: - id - version additionalProperties: false pageSelection: anyOf: - type: object properties: kind: type: string const: all required: - kind additionalProperties: false - type: object properties: kind: type: string const: selected pageIds: type: array items: type: string minLength: 1 maxLength: 256 minItems: 1 maxItems: 500 required: - kind - pageIds additionalProperties: false contexts: type: array items: type: object properties: id: 943f3feb-7449-4556-8943-309fbb7da470 surface: type: string enum: - private_view - shared_projection - print layoutMode: type: string enum: - fixed - responsive canvasWidth: type: number exclusiveMinimum: 0 maximum: 10000 viewport: type: object properties: width: type: integer exclusiveMinimum: 0 maximum: 10000 height: type: integer exclusiveMinimum: 0 maximum: 20000 required: - width - height additionalProperties: false scale: type: number exclusiveMinimum: 0 maximum: 10 locale: type: string minLength: 2 maxLength: 64 timezone: type: string minLength: 1 maxLength: 128 scenarioId: type: string const: saved-defaults required: - id - surface - layoutMode - canvasWidth - viewport - scale - locale - timezone - scenarioId additionalProperties: false minItems: 1 maxItems: 256 dataPolicy: type: string enum: - require_existing_output - allow_declared_empty_states emptyStateDeclarations: type: array items: type: object properties: pageId: 0aaa4659-57df-4a46-a50d-90f31b393c3b elementId: 5c5fbe67-532b-49f5-94e0-d288aea791bb contextId: fe78fdd7-5c78-423a-9363-28d86fc2a62c state: type: string enum: - empty - error reason: type: string minLength: 1 maxLength: 1000 required: - pageId - elementId - contextId - state - reason additionalProperties: false maxItems: 1000 requiredChecks: type: string const: profile_defaults required: - target - profile - pageSelection - contexts - dataPolicy - requiredChecks additionalProperties: false CanvasJobResponseV1: type: object properties: data: anyOf: - type: object properties: id: type: string format: uuid reportId: type: string format: uuid target: type: object properties: kind: type: string const: saved_revision reportId: type: string format: uuid revision: type: integer minimum: 0 expectedDocumentHash: type: string minLength: 1 maxLength: 256 required: - kind - reportId - revision - expectedDocumentHash additionalProperties: false status: type: string enum: - queued - running - completed - cancelled - failed - expired createdAt: type: string format: date-time expiresAt: type: string format: date-time failureCode: anyOf: - type: string enum: - work_budget_exceeded - transient_retry_limit_exceeded - probe_budget_exceeded - browser_unavailable - navigation_timeout - transport_unavailable - access_revoked - snapshot_expired - renderer_failed - type: 'null' progress: type: object properties: requestedPageContexts: type: integer minimum: 0 completedPageContexts: 0a66c997-3a06-4754-8bd0-3c24ccddf12b required: - requestedPageContexts - completedPageContexts additionalProperties: false assessment: anyOf: - type: object properties: version: type: number const: 1 assessmentId: d904c590-28ea-42e5-974a-01f7ade3d2a2 documentHash: 8e162375-e1be-4e84-9109-5a3171f7b51e profile: type: object properties: id: e4a6a720-3048-4e60-9ef5-4d1e7fb439fe version: type: number const: 1 required: - id - version additionalProperties: false coverage: type: object properties: requiredPageContexts: type: integer minimum: 0 completedPageContexts: type: integer minimum: 0 unverifiedPageContexts: type: integer minimum: 0 complete: type: boolean required: - requiredPageContexts - completedPageContexts - unverifiedPageContexts - complete additionalProperties: false structure: type: object properties: status: type: string enum: - valid - invalid - unverified required: - status additionalProperties: false render: type: object properties: status: type: string enum: - valid - invalid - unverified required: - status additionalProperties: false design: type: object properties: status: type: string enum: - assessed - unverified advisoryCount: type: integer minimum: 0 coverageGaps: type: array items: 09064a38-968e-497d-8360-85ae2153ebc7 maxItems: 64 required: - status - advisoryCount - coverageGaps additionalProperties: false data: type: object properties: status: type: string enum: - ready - partial - missing - failed - unverified issueCodes: type: array items: e047699a-45ea-4160-a930-171e1ff0e4b2 maxItems: 256 required: - status - issueCodes additionalProperties: false publication: type: object properties: status: type: string enum: - not_published - current - stale - failed - unverified required: - status additionalProperties: false safeToCommit: type: boolean findingCount: 0df373d0-d0f3-4fa2-8165-5ae2b2ba5d36 required: - version - assessmentId - documentHash - profile - coverage - structure - render - design - data - publication - safeToCommit - findingCount additionalProperties: false - type: 'null' required: - id - reportId - target - status - createdAt - expiresAt - failureCode - progress - assessment additionalProperties: false - type: object properties: version: type: number const: 1 kind: type: string const: composition id: type: string format: uuid reportId: type: string format: uuid changeSetId: type: string format: uuid status: type: string enum: - queued - running - completed - cancelled - failed - expired createdAt: type: string format: date-time expiresAt: type: string format: date-time failureCode: anyOf: - type: string enum: - access_revoked - stage_conflict - input_conflict - runtime_conflict - work_budget_exceeded - transient_retry_limit_exceeded - renderer_failed - composition_infeasible - nonconvergent - measurement_unverified - trace_limit - expired - type: 'null' progress: type: object properties: acceptedMeasurements: type: integer minimum: 0 maximum: 3584 required: - acceptedMeasurements additionalProperties: false plan: anyOf: - type: object properties: id: type: string format: uuid planHash: type: string pattern: ^[0-9a-f]{64}$ documentHash: ff31d75c-694c-4a46-a98e-ead65268b536 required: - id - planHash - documentHash additionalProperties: false - type: 'null' required: - version - kind - id - reportId - changeSetId - status - createdAt - expiresAt - failureCode - progress - plan 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.