> ## 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 visibility, sources and evidence

> 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/{id}/analytics
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/{id}/analytics:
    get:
      tags:
        - Prompts
      summary: Read group visibility, sources and evidence
      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: getV2GroupsIdAnalytics
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
        - name: section
          in: query
          required: false
          schema:
            type: string
            enum:
              - sources
              - competitors
              - evidence
            default: sources
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100000
            default: 1
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - default
              - name
              - citations
              - answers
              - mentions
              - position
              - date
            default: default
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
        - name: windowDays
          in: query
          required: false
          schema:
            type: number
            default: 30
      responses:
        '200':
          description: Group analytics.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          section:
                            type: string
                            enum:
                              - sources
                              - competitors
                              - evidence
                            default: sources
                          page:
                            type: integer
                            minimum: 1
                            maximum: 100000
                            default: 1
                          sort:
                            type: string
                            enum:
                              - default
                              - name
                              - citations
                              - answers
                              - mentions
                              - position
                              - date
                            default: default
                          direction:
                            type: string
                            enum:
                              - asc
                              - desc
                            default: asc
                          pageSize:
                            type: number
                          total:
                            type: number
                        required:
                          - pageSize
                          - total
                        additionalProperties: false
                      group:
                        type: object
                        properties:
                          id:
                            type: number
                          revision:
                            type: number
                          name:
                            type: string
                          description:
                            type:
                              - string
                              - 'null'
                          colorHex:
                            type:
                              - string
                              - 'null'
                          pathLabel:
                            type: string
                          groupType:
                            type: string
                            enum:
                              - funnel_stage
                              - intent
                              - brand
                              - product
                              - audience
                              - geography
                              - campaign
                              - custom
                              - core
                              - funnel
                              - persona
                              - product_line
                              - suggested
                          directPromptCount:
                            type: number
                          totalPromptCount:
                            type: number
                          descendants:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: number
                                name:
                                  type: string
                                pathLabel:
                                  type: string
                                promptCount:
                                  type: number
                              required:
                                - id
                                - name
                                - pathLabel
                                - promptCount
                              additionalProperties: false
                        required:
                          - id
                          - revision
                          - name
                          - description
                          - colorHex
                          - pathLabel
                          - groupType
                          - directPromptCount
                          - totalPromptCount
                          - descendants
                        additionalProperties: false
                      window:
                        type: object
                        properties:
                          days:
                            type: number
                          from:
                            type: string
                          to:
                            type: string
                        required:
                          - days
                          - from
                          - to
                        additionalProperties: false
                      visibility:
                        type: object
                        properties:
                          answerCount:
                            type: number
                          presenceCount:
                            type: number
                          presenceRate:
                            type:
                              - number
                              - 'null'
                          firstPlaceRate:
                            type:
                              - number
                              - 'null'
                          averagePosition:
                            type:
                              - number
                              - 'null'
                          points:
                            type: array
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                presenceRate:
                                  type:
                                    - number
                                    - 'null'
                                firstPlaceRate:
                                  type:
                                    - number
                                    - 'null'
                              required:
                                - date
                                - presenceRate
                                - firstPlaceRate
                              additionalProperties: false
                        required:
                          - answerCount
                          - presenceCount
                          - presenceRate
                          - firstPlaceRate
                          - averagePosition
                          - points
                        additionalProperties: false
                      sentiment:
                        type: object
                        properties:
                          positive:
                            type: number
                          neutral:
                            type: number
                          negative:
                            type: number
                          total:
                            type: number
                          score:
                            type:
                              - number
                              - 'null'
                        required:
                          - positive
                          - neutral
                          - negative
                          - total
                          - score
                        additionalProperties: false
                      prompts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            label:
                              type: string
                            directMembership:
                              type: boolean
                            answerCount:
                              type: number
                            visibility:
                              type:
                                - number
                                - 'null'
                          required:
                            - id
                            - label
                            - directMembership
                            - answerCount
                            - visibility
                          additionalProperties: false
                      sources:
                        type: array
                        items:
                          type: object
                          properties:
                            domain:
                              type: string
                            citationCount:
                              type: number
                            answerCount:
                              type: number
                          required:
                            - domain
                            - citationCount
                            - answerCount
                          additionalProperties: false
                      competitors:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            label:
                              type: string
                            primaryDomain:
                              type:
                                - string
                                - 'null'
                            mentionCount:
                              type: number
                            answerCount:
                              type: number
                            averagePosition:
                              type:
                                - number
                                - 'null'
                          required:
                            - id
                            - label
                            - primaryDomain
                            - mentionCount
                            - answerCount
                            - averagePosition
                          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
                      answers:
                        type: array
                        items:
                          type: object
                          properties:
                            runId:
                              type: number
                            promptId:
                              type: number
                            promptLabel:
                              type: string
                            occurredAt:
                              type: string
                          required:
                            - runId
                            - promptId
                            - promptLabel
                            - occurredAt
                          additionalProperties: false
                      generatedAt:
                        type: string
                    required:
                      - group
                      - window
                      - visibility
                      - sentiment
                      - prompts
                      - sources
                      - competitors
                      - rules
                      - answers
                      - generatedAt
                    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.

````