> ## 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 group comparisons and grouping opportunities

> Read analytics for the authenticated workspace. Requires group feature access and groups:read for MCP. Use section and page to traverse a group detail table. Supported comparison windows: 7, 30 and 90 days.



## OpenAPI

````yaml GET /api/v2/groups/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/groups/overview:
    get:
      tags:
        - Prompts
      summary: Read group comparisons and grouping opportunities
      description: >-
        Read analytics for the authenticated workspace. Requires group feature
        access and groups:read for MCP. Use section and page to traverse a group
        detail table. Supported comparison windows: 7, 30 and 90 days.
      operationId: getV2GroupsOverview
      parameters:
        - name: windowDays
          in: query
          required: false
          schema:
            type: number
            default: 30
        - name: personaId
          in: query
          required: false
          schema:
            type: integer
            exclusiveMinimum: 0
      responses:
        '200':
          description: Group analytics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generatedAt:
                        type: string
                      comparisonWindowDays:
                        type: number
                      kpis:
                        type: object
                        properties:
                          activeGroups:
                            type: number
                          segmentationTypes:
                            type: number
                          groupedPrompts:
                            type: number
                          totalPrompts:
                            type: number
                          ungroupedPrompts:
                            type: number
                          groupedPercent:
                            type: number
                          ungroupedPercent:
                            type: number
                          suggestedGroups:
                            type: number
                        required:
                          - activeGroups
                          - segmentationTypes
                          - groupedPrompts
                          - totalPrompts
                          - ungroupedPrompts
                          - groupedPercent
                          - ungroupedPercent
                          - suggestedGroups
                        additionalProperties: false
                      groups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            revision:
                              type: number
                            name:
                              type: string
                            description:
                              type:
                                - string
                                - 'null'
                            colorHex:
                              type:
                                - string
                                - 'null'
                            parentGroupId:
                              type:
                                - number
                                - 'null'
                            pathLabel:
                              type: string
                            groupType:
                              type: string
                              enum:
                                - funnel_stage
                                - intent
                                - brand
                                - product
                                - audience
                                - geography
                                - campaign
                                - custom
                                - core
                                - funnel
                                - persona
                                - product_line
                                - suggested
                            groupTypeSource:
                              type: string
                              enum:
                                - manual
                                - inferred
                            promptCount:
                              type: number
                            averageVisibility:
                              type:
                                - number
                                - 'null'
                            trend:
                              type: array
                              items:
                                type: object
                                properties:
                                  label:
                                    type: string
                                  value:
                                    type: number
                                required:
                                  - label
                                  - value
                                additionalProperties: false
                            comparisonMetrics:
                              type: object
                              properties:
                                visibility:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                firstPlace:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                sentiment:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                averagePosition:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                              required:
                                - visibility
                                - firstPlace
                                - sentiment
                                - averagePosition
                              additionalProperties: false
                            status:
                              type: string
                              enum:
                                - critical
                                - recommended
                                - normal
                                - archived
                            archivedAt:
                              type:
                                - string
                                - 'null'
                            updatedAt:
                              type: string
                          required:
                            - id
                            - revision
                            - name
                            - description
                            - colorHex
                            - parentGroupId
                            - pathLabel
                            - groupType
                            - groupTypeSource
                            - promptCount
                            - averageVisibility
                            - trend
                            - comparisonMetrics
                            - status
                            - archivedAt
                            - updatedAt
                          additionalProperties: false
                      archivedGroups:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            revision:
                              type: number
                            name:
                              type: string
                            description:
                              type:
                                - string
                                - 'null'
                            colorHex:
                              type:
                                - string
                                - 'null'
                            parentGroupId:
                              type:
                                - number
                                - 'null'
                            pathLabel:
                              type: string
                            groupType:
                              type: string
                              enum:
                                - funnel_stage
                                - intent
                                - brand
                                - product
                                - audience
                                - geography
                                - campaign
                                - custom
                                - core
                                - funnel
                                - persona
                                - product_line
                                - suggested
                            groupTypeSource:
                              type: string
                              enum:
                                - manual
                                - inferred
                            promptCount:
                              type: number
                            averageVisibility:
                              type:
                                - number
                                - 'null'
                            trend:
                              type: array
                              items:
                                type: object
                                properties:
                                  label:
                                    type: string
                                  value:
                                    type: number
                                required:
                                  - label
                                  - value
                                additionalProperties: false
                            comparisonMetrics:
                              type: object
                              properties:
                                visibility:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                firstPlace:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                sentiment:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                                averagePosition:
                                  type: object
                                  properties:
                                    latest:
                                      type:
                                        - number
                                        - 'null'
                                    observationCount:
                                      type: number
                                    trend:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          label:
                                            type: string
                                          value:
                                            type:
                                              - number
                                              - 'null'
                                        required:
                                          - label
                                          - value
                                        additionalProperties: false
                                  required:
                                    - latest
                                    - observationCount
                                    - trend
                                  additionalProperties: false
                              required:
                                - visibility
                                - firstPlace
                                - sentiment
                                - averagePosition
                              additionalProperties: false
                            status:
                              type: string
                              enum:
                                - critical
                                - recommended
                                - normal
                                - archived
                            archivedAt:
                              type:
                                - string
                                - 'null'
                            updatedAt:
                              type: string
                          required:
                            - id
                            - revision
                            - name
                            - description
                            - colorHex
                            - parentGroupId
                            - pathLabel
                            - groupType
                            - groupTypeSource
                            - promptCount
                            - averageVisibility
                            - trend
                            - comparisonMetrics
                            - status
                            - archivedAt
                            - updatedAt
                          additionalProperties: false
                      coverage:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              anyOf:
                                - type: string
                                  enum:
                                    - funnel_stage
                                    - intent
                                    - brand
                                    - product
                                    - audience
                                    - geography
                                    - campaign
                                    - custom
                                    - core
                                    - funnel
                                    - persona
                                    - product_line
                                    - suggested
                                - type: string
                                  const: ungrouped
                            label:
                              type: string
                            promptCount:
                              type: number
                            percent:
                              type: number
                            color:
                              type: string
                          required:
                            - key
                            - label
                            - promptCount
                            - percent
                            - color
                          additionalProperties: false
                      opportunities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            copyKey:
                              type: string
                            type:
                              type: string
                              enum:
                                - funnel_stage
                                - intent
                                - brand
                                - product
                                - audience
                                - geography
                                - campaign
                                - custom
                                - core
                                - funnel
                                - persona
                                - product_line
                                - suggested
                            title:
                              type: string
                            description:
                              type: string
                            promptCount:
                              type: number
                            promptIds:
                              type: array
                              items:
                                type: number
                            promptPreview:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  label:
                                    type: string
                                required:
                                  - id
                                  - label
                                additionalProperties: false
                            suggestedGroupName:
                              type: string
                            suggestedColorHex:
                              type: string
                            impact:
                              type: string
                              enum:
                                - high
                                - medium
                                - low
                            primaryAction:
                              type: string
                              enum:
                                - create_group
                                - review_prompts
                          required:
                            - id
                            - type
                            - title
                            - description
                            - promptCount
                            - promptIds
                            - promptPreview
                            - suggestedGroupName
                            - suggestedColorHex
                            - impact
                            - primaryAction
                          additionalProperties: false
                      clusters:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            copyKey:
                              type: string
                            type:
                              type: string
                              enum:
                                - funnel_stage
                                - intent
                                - brand
                                - product
                                - audience
                                - geography
                                - campaign
                                - custom
                                - core
                                - funnel
                                - persona
                                - product_line
                                - suggested
                            title:
                              type: string
                            description:
                              type: string
                            promptCount:
                              type: number
                            promptIds:
                              type: array
                              items:
                                type: number
                            promptPreview:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  label:
                                    type: string
                                required:
                                  - id
                                  - label
                                additionalProperties: false
                            suggestedGroupName:
                              type: string
                            suggestedColorHex:
                              type: string
                          required:
                            - id
                            - type
                            - title
                            - description
                            - promptCount
                            - promptIds
                            - promptPreview
                            - suggestedGroupName
                            - suggestedColorHex
                          additionalProperties: false
                      rules:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            version:
                              type: number
                            name:
                              type: string
                            groupId:
                              type: number
                            groupName:
                              type: string
                            groupType:
                              type: string
                              enum:
                                - funnel_stage
                                - intent
                                - brand
                                - product
                                - audience
                                - geography
                                - campaign
                                - custom
                                - core
                                - funnel
                                - persona
                                - product_line
                                - suggested
                            conditionType:
                              type: string
                              enum:
                                - contains_any
                                - contains_all
                                - regex
                            conditionPayload:
                              type: object
                              properties:
                                keywords:
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                                    maxLength: 80
                                  maxItems: 20
                                pattern:
                                  type: string
                                  maxLength: 512
                                caseSensitive:
                                  type: boolean
                                negate:
                                  type: boolean
                                platforms:
                                  type: array
                                  items:
                                    enum:
                                      - chatgpt
                                      - ai_overview
                                      - ai_mode
                                      - gemini
                                      - perplexity
                                      - claude
                                    type: string
                                  maxItems: 20
                                regions:
                                  type: array
                                  items:
                                    type: string
                                    minLength: 1
                                    maxLength: 64
                                  maxItems: 20
                              additionalProperties: false
                            applyOn:
                              type: array
                              items:
                                type: string
                                enum:
                                  - prompt_create
                                  - prompt_update
                                  - backfill
                            conditionSummary:
                              type: string
                            status:
                              type: string
                              enum:
                                - draft
                                - active
                                - paused
                                - archived
                            priority:
                              type: number
                            lastPreviewCount:
                              type:
                                - number
                                - 'null'
                            lastAppliedVersion:
                              type:
                                - number
                                - 'null'
                            lastAppliedAt:
                              type:
                                - string
                                - 'null'
                            backfill:
                              anyOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                    status:
                                      type: string
                                      enum:
                                        - queued
                                        - running
                                        - succeeded
                                        - failed
                                        - superseded
                                    scannedCount:
                                      type: number
                                    matchedCount:
                                      type: number
                                    errorCode:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - status
                                    - scannedCount
                                    - matchedCount
                                    - errorCode
                                  additionalProperties: false
                                - type: 'null'
                            updatedAt:
                              type: string
                          required:
                            - id
                            - version
                            - name
                            - groupId
                            - groupName
                            - groupType
                            - conditionType
                            - conditionPayload
                            - applyOn
                            - conditionSummary
                            - status
                            - priority
                            - lastPreviewCount
                            - lastAppliedVersion
                            - lastAppliedAt
                            - backfill
                            - updatedAt
                          additionalProperties: false
                      brandRuleTerms:
                        type: array
                        items:
                          type: string
                    required:
                      - generatedAt
                      - comparisonWindowDays
                      - kpis
                      - groups
                      - archivedGroups
                      - coverage
                      - opportunities
                      - clusters
                      - rules
                      - brandRuleTerms
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Invalid filters.
        '403':
          description: Feature or scope access denied.
        '404':
          description: Group not found.
components:
  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.

````