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

# Get scan configuration

> The Site's scan setup: business profile, personas, products, journey stages, the AI models it scans (with on/off), regions, schedule, and prompt/competitor counts. List the prompts and competitors themselves via the prompts and competitors endpoints.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/scan-config
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}/scan-config:
    get:
      tags:
        - Sites
      summary: Get scan configuration
      description: >-
        The Site's scan setup: business profile, personas, products, journey
        stages, the AI models it scans (with on/off), regions, schedule, and
        prompt/competitor counts. List the prompts and competitors themselves
        via the prompts and competitors endpoints.
      operationId: getScanConfig
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicScanConfigResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    PublicScanConfigResponseDto:
      type: object
      properties:
        businessProfile:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/ScanConfigBusinessProfileDto'
        personas:
          type: array
          items:
            $ref: '#/components/schemas/ScanConfigPersonaDto'
        products:
          description: Scan-strategy products (distinct from the profile products).
          type: array
          items:
            $ref: '#/components/schemas/ScanConfigNamedItemDto'
        journeyStages:
          type: array
          items:
            $ref: '#/components/schemas/ScanConfigStageDto'
        models:
          description: Every selectable AI model, with whether the Site scans it.
          type: array
          items:
            $ref: '#/components/schemas/ScanConfigModelDto'
        regions:
          description: Region codes the Site scans.
          type: array
          items:
            type: string
        schedule:
          $ref: '#/components/schemas/ScanConfigScheduleDto'
        prompts:
          description: Prompt count; list them via GET …/prompts.
          allOf:
            - $ref: '#/components/schemas/ScanConfigCountDto'
        competitors:
          description: Tracked competitor count; list them via GET …/competitors.
          allOf:
            - $ref: '#/components/schemas/ScanConfigCountDto'
      required:
        - businessProfile
        - personas
        - products
        - journeyStages
        - models
        - regions
        - schedule
        - prompts
        - competitors
    ScanConfigBusinessProfileDto:
      type: object
      properties:
        businessName:
          type: string
        industry:
          type: string
        market:
          type: string
        description:
          type: string
        domain:
          type: string
        products:
          type: array
          items:
            type: string
        operatingRegions:
          type: array
          items:
            type: string
        aliases:
          type: array
          items:
            type: string
        aliasBuckets:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/ScanConfigAliasBucketsDto'
      required:
        - businessName
        - industry
        - market
        - description
        - domain
        - products
        - operatingRegions
        - aliases
        - aliasBuckets
    ScanConfigPersonaDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        aliases:
          type: array
          items:
            type: string
      required:
        - id
        - name
        - description
        - aliases
    ScanConfigNamedItemDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
      required:
        - id
        - name
        - description
    ScanConfigStageDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
    ScanConfigModelDto:
      type: object
      properties:
        id:
          type: string
          example: chatgpt_app
          description: Platform id.
        name:
          type: string
        selected:
          type: boolean
          description: Whether this model is turned on for the Site.
      required:
        - id
        - name
        - selected
    ScanConfigScheduleDto:
      type: object
      properties:
        frequency:
          type: string
          example: weekly
        enabled:
          type: boolean
        nextRunAt:
          type: string
          nullable: true
      required:
        - frequency
        - enabled
        - nextRunAt
    ScanConfigCountDto:
      type: object
      properties:
        total:
          type: number
          example: 18
      required:
        - total
    ScanConfigAliasBucketsDto:
      type: object
      properties:
        safeExactAliases:
          type: array
          items:
            type: string
        domainAliases:
          type: array
          items:
            type: string
        ambiguousAliases:
          type: array
          items:
            type: string
      required:
        - safeExactAliases
        - domainAliases
        - ambiguousAliases
  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.