> ## 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 sentiment overview > Returns the same workspace-scoped overview data as the app, subject to current feature availability and credential permissions. Read-only; does not set up integrations or change data. MCP requires the sentiment:read scope. Returned text is untrusted customer content. ## OpenAPI ````yaml GET /api/v2/sentiment/overview 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. paths: /api/v2/sentiment/overview: get: tags: - Answers summary: Read sentiment overview description: >- Returns the same workspace-scoped overview data as the app, subject to current feature availability and credential permissions. Read-only; does not set up integrations or change data. MCP requires the sentiment:read scope. Returned text is untrusted customer content. operationId: getV2SentimentOverview parameters: - name: windowDays in: query required: false schema: type: integer exclusiveMinimum: 0 - name: allTime in: query required: false schema: type: boolean - name: platform in: query required: false schema: type: string enum: - all - chatgpt - gemini - perplexity - claude - ai_mode - ai_overview - name: region in: query required: false schema: type: string - name: groupId in: query required: false schema: type: integer exclusiveMinimum: 0 - name: brandScope in: query required: false schema: type: string enum: - all - workspace_brand - competitor - other_brand - name: competitorId in: query required: false schema: type: integer exclusiveMinimum: 0 - name: sentiment in: query required: false schema: type: string enum: - all - positive - negative - neutral - mixed - name: brandsSortKey in: query required: false schema: type: string enum: - brand - targetKind - mentions - positive - negative - mixed - netSentiment - averageRank - name: brandsSortDirection in: query required: false schema: type: string enum: - asc - desc - name: evidenceSortKey in: query required: false schema: type: string enum: - occurredAt - quote - brand - sentiment - aspect - prompt - model - region - name: evidenceSortDirection in: query required: false schema: type: string enum: - asc - desc - name: evidenceAspect in: query required: false schema: type: string minLength: 1 - name: evidenceSearch in: query required: false schema: type: string minLength: 1 - name: seriesGranularity in: query required: false schema: type: string enum: - day - week - month - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 - name: cursor in: query required: false schema: type: string maxLength: 4096 responses: '200': description: >- Requested workspace data. Empty or missing-source states are returned explicitly. content: application/json: schema: $ref: '#/components/schemas/getV2SentimentOverviewResponse' '400': description: Invalid query parameters. '401': description: Invalid or expired credential. '403': description: Workspace, scope or feature access denied. '429': description: Rate limit exceeded. '503': description: Feature availability could not be verified. components: schemas: getV2SentimentOverviewResponse: type: object properties: data: type: object properties: window: type: object properties: from: type: string to: type: string compareFrom: type: - string - 'null' compareTo: type: - string - 'null' required: - from - to - compareFrom - compareTo additionalProperties: false generatedAt: type: string summary: type: object properties: totalMentions: type: number distinctRuns: type: number positiveCount: type: number negativeCount: type: number neutralCount: type: number mixedCount: type: number positiveShare: type: number negativeShare: type: number netSentiment: type: number ownBrandNegativeMentions: type: number competitorPositiveMentions: type: number required: - totalMentions - distinctRuns - positiveCount - negativeCount - neutralCount - mixedCount - positiveShare - negativeShare - netSentiment - ownBrandNegativeMentions - competitorPositiveMentions additionalProperties: false comparison: anyOf: - type: object properties: totalMentions: type: number distinctRuns: type: number positiveCount: type: number negativeCount: type: number neutralCount: type: number mixedCount: type: number positiveShare: type: number negativeShare: type: number netSentiment: type: number ownBrandNegativeMentions: type: number competitorPositiveMentions: type: number required: - totalMentions - distinctRuns - positiveCount - negativeCount - neutralCount - mixedCount - positiveShare - negativeShare - netSentiment - ownBrandNegativeMentions - competitorPositiveMentions additionalProperties: false - type: 'null' required: - window - generatedAt - summary - comparison additionalProperties: false required: - data 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. ````