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

# Discover competitor identities

> Workspace-scoped app capability through the customer API. MCP requires the matching prompts or competitors permission. Competitor writes require current admin permission. Personal review sessions additionally require user-authorized OAuth and are unavailable to workspace service keys. Identity decisions verify the discovered candidate revision and replay by UUID. Review applications report per-item outcomes; inspect conflicts before continuing.



## OpenAPI

````yaml GET /api/v2/brands/suggestions
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/brands/suggestions:
    get:
      tags:
        - Brands
      summary: Discover competitor identities
      description: >-
        Workspace-scoped app capability through the customer API. MCP requires
        the matching prompts or competitors permission. Competitor writes
        require current admin permission. Personal review sessions additionally
        require user-authorized OAuth and are unavailable to workspace service
        keys. Identity decisions verify the discovered candidate revision and
        replay by UUID. Review applications report per-item outcomes; inspect
        conflicts before continuing.
      operationId: getV2BrandsSuggestions
      parameters:
        - name: candidate
          in: query
          required: false
          schema:
            type: string
            minLength: 3
            maxLength: 600
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100000
            default: 1
        - name: sortKey
          in: query
          required: false
          schema:
            type: string
            enum:
              - aliasText
              - aliasType
              - mentionCount
              - suggested
              - examplePromptTitle
              - confidenceScore
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: filter
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - high
              - needs
              - new
            default: all
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      candidate:
                        type: object
                        properties:
                          key:
                            type: string
                          competitorId:
                            type:
                              - number
                              - 'null'
                        required:
                          - key
                          - competitorId
                        additionalProperties: false
                      suggestions:
                        type: array
                        items:
                          type: object
                          properties:
                            candidateKey:
                              type: string
                            candidateRevision:
                              type: string
                            aliasType:
                              type: string
                              enum:
                                - name
                                - domain
                            aliasText:
                              type: string
                            normalizedAlias:
                              type: string
                            mentionCount:
                              type: number
                            examplePromptTitle:
                              type:
                                - string
                                - 'null'
                            suggestedCompetitorId:
                              type:
                                - number
                                - 'null'
                            suggestedCompetitorLabel:
                              type:
                                - string
                                - 'null'
                            suggestedCompetitorIsOwnBrand:
                              type: boolean
                            confidenceScore:
                              type: number
                            confidenceLevel:
                              type: string
                              enum:
                                - high
                                - medium
                                - low
                                - none
                          required:
                            - candidateKey
                            - candidateRevision
                            - aliasType
                            - aliasText
                            - normalizedAlias
                            - mentionCount
                            - examplePromptTitle
                            - suggestedCompetitorId
                            - suggestedCompetitorLabel
                            - suggestedCompetitorIsOwnBrand
                            - confidenceScore
                            - confidenceLevel
                          additionalProperties: false
                      filterCounts:
                        type: object
                        properties:
                          all:
                            type: number
                          high:
                            type: number
                          needs:
                            type: number
                          new:
                            type: number
                        required:
                          - all
                          - high
                          - needs
                          - new
                        additionalProperties: false
                      pageInfo:
                        type: object
                        properties:
                          page:
                            type: number
                          limit:
                            type: number
                          totalCount:
                            type: number
                          totalPages:
                            type: number
                          filter:
                            type: string
                            enum:
                              - all
                              - high
                              - needs
                              - new
                        required:
                          - page
                          - limit
                          - totalCount
                          - totalPages
                          - filter
                        additionalProperties: false
                    required:
                      - suggestions
                      - filterCounts
                      - pageInfo
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Invalid request.
        '403':
          description: Scope, role or personal ownership denied.
        '404':
          description: Record not found.
        '409':
          description: Candidate, review revision or retry conflict.
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.

````