> ## 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.

# Get source overview

> Analyse cited domains, pages and ownership across answers.

Required scopes: `read`.


## OpenAPI

````yaml GET /api/v2/sources/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/sources/overview:
    get:
      tags:
        - Sources and citations
      summary: Get source overview
      description: >-
        Analyse cited domains, pages and ownership across answers. Required
        scopes: `read`.
      operationId: getV2SourcesOverview
      parameters:
        - name: promptId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
        - name: rootDomain
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 255
        - name: windowDays
          in: query
          required: false
          schema:
            type: number
            minimum: 1
            maximum: 365
            default: 30
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: metric
          in: query
          required: false
          schema:
            enum:
              - mentions
              - influence
            default: mentions
            type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getV2SourcesOverviewResponse200'
        default:
          description: >-
            Request failed. Inspect the error code and request identifier; retry
            only when the failure is retryable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    getV2SourcesOverviewResponse200:
      type: object
      properties:
        data:
          type: object
          properties:
            window:
              type: object
              properties:
                start:
                  type: string
                end:
                  type: string
                days:
                  type: number
              required:
                - start
                - end
                - days
            filters:
              type: object
              properties:
                promptId:
                  anyOf:
                    - type: 'null'
                    - type: string
                rootDomain:
                  anyOf:
                    - type: 'null'
                    - type: string
                windowDays:
                  type: number
                metric:
                  enum:
                    - mentions
                    - influence
                  type: string
              required:
                - promptId
                - rootDomain
                - windowDays
            stats:
              type: object
              properties:
                mentionCount:
                  type: number
                influenceScore:
                  type: number
                citationCount:
                  type: number
                linkCount:
                  type: number
                uniqueDomains:
                  type: number
                activePrompts:
                  type: number
                latestActivityAt:
                  anyOf:
                    - type: 'null'
                    - type: string
              required:
                - mentionCount
                - influenceScore
                - citationCount
                - linkCount
                - uniqueDomains
                - activePrompts
                - latestActivityAt
            topDomains:
              type: array
              items:
                type: object
                properties:
                  rootDomain:
                    type: string
                  mentionCount:
                    type: number
                  influenceScore:
                    type: number
                required:
                  - rootDomain
                  - mentionCount
                  - influenceScore
            dailyTotals:
              type: array
              items:
                type: object
                properties:
                  bucketDay:
                    type: string
                  mentionCount:
                    type: number
                  influenceScore:
                    type: number
                required:
                  - bucketDay
                  - mentionCount
                  - influenceScore
            generatedAt:
              type: string
            insights:
              type: array
              items:
                anyOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        const: top-domain
                      rootDomain:
                        type: string
                      mentionCount:
                        type: number
                      share:
                        anyOf:
                          - type: 'null'
                          - type: number
                    required:
                      - id
                      - rootDomain
                      - mentionCount
                      - share
                  - type: object
                    properties:
                      id:
                        type: string
                        const: rising-domain
                      rootDomain:
                        type: string
                      delta:
                        type: number
                      latest:
                        type: number
                      previous:
                        type: number
                      momentumPercent:
                        anyOf:
                          - type: 'null'
                          - type: number
                    required:
                      - id
                      - rootDomain
                      - delta
                      - latest
                      - previous
                      - momentumPercent
                  - type: object
                    properties:
                      id:
                        type: string
                        const: latest-activity
                      activityAt:
                        type: string
                    required:
                      - id
                      - activityAt
                  - type: object
                    properties:
                      promptId:
                        anyOf:
                          - type: 'null'
                          - type: string
                      id:
                        type: string
                        const: top-prompt
                      promptLabel:
                        anyOf:
                          - type: 'null'
                          - type: string
                      mentionCount:
                        type: number
                      share:
                        anyOf:
                          - type: 'null'
                          - type: number
                    required:
                      - promptId
                      - id
                      - promptLabel
                      - mentionCount
                      - share
          required:
            - window
            - filters
            - stats
            - topDomains
            - dailyTotals
            - generatedAt
            - insights
      required:
        - data
    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.

````