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

# List source catalogues

> Access document-bound client sessions, queries, schedules, bindings and write claims.

Required scopes: `client:read`.


## OpenAPI

````yaml GET /api/v2/metrics/client/catalogues
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/metrics/client/catalogues:
    get:
      tags:
        - Spreadsheet clients
      summary: List source catalogues
      description: >-
        Access document-bound client sessions, queries, schedules, bindings and
        write claims. Required scopes: `client:read`.
      operationId: getV2MetricsClientCatalogues
      parameters:
        - name: x-metrics-client-audience
          in: header
          required: true
          schema:
            enum:
              - chatobserver-metrics-sheets
              - chatobserver-metrics-excel
            type: string
          description: The audience bound to the authorised client session.
        - name: x-metrics-document-reference
          in: header
          required: true
          schema:
            type: string
            pattern: ^[a-f0-9]{64}$
          description: The document reference hash bound to the client session.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getV2MetricsClientCataloguesResponse200'
        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/DataError'
      security:
        - ClientSession: []
components:
  schemas:
    getV2MetricsClientCataloguesResponse200:
      type: object
      properties:
        data:
          type: object
          properties:
            snapshots:
              type: array
              items:
                type: object
                properties:
                  sourceAccountId:
                    type: string
                  queryTypes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        description:
                          type: string
                        providerResource:
                          type: string
                        grain:
                          type: string
                        default:
                          anyOf:
                            - type: boolean
                              const: false
                            - type: boolean
                              const: true
                      required:
                        - id
                        - label
                  queryOptions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        description:
                          type: string
                        type:
                          enum:
                            - boolean
                            - enum
                          type: string
                        values:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                              label:
                                type: string
                            required:
                              - value
                              - label
                        required:
                          anyOf:
                            - type: boolean
                              const: false
                            - type: boolean
                              const: true
                        defaultValue:
                          anyOf:
                            - type: string
                            - type: boolean
                              const: false
                            - type: boolean
                              const: true
                      required:
                        - id
                        - label
                        - type
                  limits:
                    type: object
                    properties:
                      maximumDimensions:
                        type: number
                      maximumMetrics:
                        type: number
                      maximumRows:
                        type: number
                    required:
                      - maximumDimensions
                      - maximumMetrics
                      - maximumRows
                  capabilities:
                    type: object
                    properties:
                      queryOrdering:
                        enum:
                          - provider
                          - none
                        type: string
                      supportsMetricFilters:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                      supportsMultipleDateRanges:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                      supportsComparisons:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                      supportsPivots:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                      supportsMultipleAccounts:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                      supportsNestedFilters:
                        anyOf:
                          - type: boolean
                            const: false
                          - type: boolean
                            const: true
                    required:
                      - queryOrdering
                      - supportsMetricFilters
                      - supportsMultipleDateRanges
                      - supportsComparisons
                      - supportsPivots
                  reportingLagDays:
                    type: number
                  completenessNote:
                    anyOf:
                      - type: 'null'
                      - type: string
                  snapshot:
                    type: object
                    properties:
                      id:
                        type: string
                      expiresAt:
                        anyOf:
                          - type: 'null'
                          - type: string
                      workspaceId:
                        anyOf:
                          - type: 'null'
                          - type: string
                      fingerprint:
                        type: string
                      connectorKey:
                        type: string
                      discoveredAt:
                        type: string
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              enum:
                                - string
                                - number
                                - boolean
                                - integer
                                - date
                                - json
                                - duration
                                - url
                                - percent
                                - currency
                                - datetime
                                - decimal
                                - image_url
                              type: string
                            id:
                              type: string
                            description:
                              anyOf:
                                - type: 'null'
                                - type: string
                            label:
                              type: string
                            role:
                              enum:
                                - metric
                                - dimension
                                - identifier
                                - attribute
                              type: string
                            providerFieldId:
                              type: string
                            aggregation:
                              anyOf:
                                - type: 'null'
                                - type: string
                            compatibleFieldIds:
                              type: array
                              items:
                                type: string
                            supportedFilterOperators:
                              type: array
                              items:
                                enum:
                                  - equals
                                  - not_equals
                                  - contains
                                  - greater_than
                                  - less_than
                                  - in
                                  - between
                                  - is_null
                                  - is_not_null
                                  - not_in
                                  - not_contains
                                  - starts_with
                                  - ends_with
                                  - regex
                                  - not_regex
                                  - greater_than_or_equal
                                  - less_than_or_equal
                                type: string
                            semanticTags:
                              type: array
                              items:
                                type: string
                            queryTypeIds:
                              type: array
                              items:
                                type: string
                            hidden:
                              anyOf:
                                - type: boolean
                                  const: false
                                - type: boolean
                                  const: true
                            deprecated:
                              anyOf:
                                - type: boolean
                                  const: false
                                - type: boolean
                                  const: true
                          required:
                            - type
                            - id
                            - description
                            - label
                            - role
                            - providerFieldId
                            - aggregation
                            - compatibleFieldIds
                            - supportedFilterOperators
                            - semanticTags
                            - queryTypeIds
                            - hidden
                            - deprecated
                      queryType:
                        type: string
                      providerSchemaVersion:
                        anyOf:
                          - type: 'null'
                          - type: string
                    required:
                      - id
                      - expiresAt
                      - workspaceId
                      - fingerprint
                      - connectorKey
                      - discoveredAt
                      - fields
                      - queryType
                      - providerSchemaVersion
                  status:
                    type: string
                required:
                  - sourceAccountId
                  - queryTypes
                  - queryOptions
                  - limits
                  - capabilities
                  - reportingLagDays
                  - completenessNote
                  - snapshot
                  - status
            changes:
              type: array
              items:
                type: object
                properties:
                  sourceAccountId:
                    type: string
                  createdAt:
                    type: string
                  id:
                    type: string
                  addedFieldIds:
                    type: array
                    items:
                      type: string
                  removedFieldIds:
                    type: array
                    items:
                      type: string
                  changedFieldIds:
                    type: array
                    items:
                      type: string
                  affectedQueryCount:
                    type: number
                required:
                  - sourceAccountId
                  - createdAt
                  - id
                  - addedFieldIds
                  - removedFieldIds
                  - changedFieldIds
                  - affectedQueryCount
          required:
            - snapshots
            - changes
      required:
        - data
    DataError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              enum:
                - internal
                - validation_failed
                - authentication_required
                - forbidden
                - not_found
                - conflict
                - precondition_failed
                - idempotency_conflict
                - capability_unavailable
                - connection_unavailable
                - reauthentication_required
                - provider_rate_limited
                - workspace_limit_exceeded
                - result_expired
                - operation_failed
                - temporarily_unavailable
              type: string
            fieldPath:
              type: array
              items:
                anyOf:
                  - type: string
                  - type: number
            parameters:
              type: object
              properties: {}
              additionalProperties:
                anyOf:
                  - type: 'null'
                  - type: string
                  - type: number
                  - type: boolean
                    const: false
                  - type: boolean
                    const: true
            repairActions:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 96
              maxItems: 10
            requestId:
              type: string
              minLength: 1
              maxLength: 160
            retryable:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
            retryAfterSeconds:
              anyOf:
                - type: 'null'
                - type: integer
                  exclusiveMinimum: 0
          required:
            - code
            - fieldPath
            - parameters
            - repairActions
            - requestId
            - retryable
            - retryAfterSeconds
          additionalProperties: false
      required:
        - error
      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.
    ClientSession:
      type: http
      scheme: bearer
      description: >-
        A client session token obtained through the client authorisation
        challenge flow.

````