> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onsomble.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List competitors

> The Site's tracked competitors — each with its name, domain, description, the reason it is tracked, and its aliases, keyed by a stable competitorId. Cursor-paginated. Pass a competitorId to the metric reports (overview, scorecard, timeline) for that competitor's numbers.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/competitors
openapi: 3.0.0
info:
  title: Onsomble API
  description: >-
    Connect Onsomble to your reporting and operational workflows. Read
    discoverability results or start a Scan from another system.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.onsomble.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Sites
    description: Sites connected to your account.
  - name: Clients
    description: Clients managed by agency accounts.
  - name: Scans
    description: Scan history, status, and controls.
  - name: Reports
    description: AI discoverability results.
paths:
  /v1/sites/{siteId}/competitors:
    get:
      tags:
        - Sites
      summary: List competitors
      description: >-
        The Site's tracked competitors — each with its name, domain,
        description, the reason it is tracked, and its aliases, keyed by a
        stable competitorId. Cursor-paginated. Pass a competitorId to the metric
        reports (overview, scorecard, timeline) for that competitor's numbers.
      operationId: listCompetitors
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: >-
            Opaque cursor from the previous page (nextCursor). Omit for the
            first page.
          schema:
            type: string
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackedCompetitorsListResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    TrackedCompetitorsListResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TrackedCompetitorDto'
        total:
          type: number
          description: Total tracked competitors matching the query.
        nextCursor:
          type: string
          nullable: true
          description: 'Opaque cursor: pass back as `cursor` for the next page.'
      required:
        - data
        - total
        - nextCursor
    TrackedCompetitorDto:
      type: object
      properties:
        competitorId:
          type: string
          format: uuid
          description: >-
            Stable id (brand identity). Pass as competitorId to the metric
            reports for this competitor’s numbers.
        name:
          type: string
        domain:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
          description: Who they are.
        reason:
          type: string
          nullable: true
          description: Why this brand is tracked for this Site.
        aliases:
          description: Names matched as this brand.
          type: array
          items:
            type: string
        domains:
          description: Domain aliases.
          type: array
          items:
            type: string
        ambiguousAliases:
          description: Words that match this brand only with more context.
          type: array
          items:
            type: string
        trackedSince:
          type: string
          example: '2026-05-01'
          description: When the brand identity was first tracked.
      required:
        - competitorId
        - name
        - domain
        - description
        - reason
        - aliases
        - domains
        - ambiguousAliases
        - trackedSince
  securitySchemes:
    apiKeyAuth:
      scheme: bearer
      bearerFormat: ons_…
      type: http
      description: An API key created in Settings → Account → API Keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.