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

# Discover filter options

> List the tags, categories, products, personas, journey stages, regions, platforms, tracked brands, and brand-mention tokens this Site supports for the report filters. Pass scanId to narrow to one Scan.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/filters
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}/filters:
    get:
      tags:
        - Sites
      summary: Discover filter options
      description: >-
        List the tags, categories, products, personas, journey stages, regions,
        platforms, tracked brands, and brand-mention tokens this Site supports
        for the report filters. Pass scanId to narrow to one Scan.
      operationId: getFilterOptions
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: scanId
          required: false
          in: query
          description: >-
            Narrow the values to those present in this Scan. Omit for the Site
            vocabulary across all Scans.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicFilterOptionsResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    PublicFilterOptionsResponseDto:
      type: object
      properties:
        scanId:
          type: string
          format: uuid
          nullable: true
          description: The Scan these values were scoped to, or null for the Site.
        regions:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterRegionDto'
        models:
          description: AI platforms to pass as the platform filter.
          type: array
          items:
            $ref: '#/components/schemas/PublicPlatformDto'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
        products:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
        personas:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
        journeyStages:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
        brands:
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterBrandDto'
        brandMentions:
          description: Allowed brandMention filter tokens.
          type: array
          items:
            $ref: '#/components/schemas/PublicFilterOptionDto'
      required:
        - scanId
        - regions
        - models
        - tags
        - categories
        - products
        - personas
        - journeyStages
        - brands
        - brandMentions
    PublicFilterRegionDto:
      type: object
      properties:
        code:
          type: string
          example: NZ:auckland
          description: Region code to filter by.
        label:
          type: string
          example: Auckland
      required:
        - code
        - label
    PublicPlatformDto:
      type: object
      properties:
        id:
          type: string
          example: chatgpt_app
          description: Stable ID for the platform and collection method.
        name:
          type: string
          example: ChatGPT
        method:
          type: string
          enum:
            - web
            - api
          example: web
          description: >-
            How Onsomble collected the result: from the public website or
            through an API.
      required:
        - id
        - name
        - method
    PublicFilterOptionDto:
      type: object
      properties:
        value:
          type: string
          example: pricing
          description: The exact token to pass to the matching filter param.
        label:
          type: string
          example: Pricing
          description: Human-readable label.
      required:
        - value
        - label
    PublicFilterBrandDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Brand identity id to pass as the brand filter.
        label:
          type: string
          example: State Insurance
      required:
        - id
        - label
  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.