> ## 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 Model Breakdown

> Compare one metric for one brand across every AI platform the most recent Scan measured. Choose the metric with metric and the brand with brandId; filter by platform or region.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/reports/model-breakdown
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}/reports/model-breakdown:
    get:
      tags:
        - Reports
      summary: Get Model Breakdown
      description: >-
        Compare one metric for one brand across every AI platform the most
        recent Scan measured. Choose the metric with metric and the brand with
        brandId; filter by platform or region.
      operationId: getModelBreakdown
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: platform
          required: false
          in: query
          description: Repeat to select AI platforms. Omit for every platform.
          schema:
            type: array
            items:
              type: string
              enum:
                - claude_api
                - chatgpt_api
                - gemini_api
                - perplexity_sonar_pro
                - chatgpt_app
                - gemini_app
                - google_ai_summaries_app
                - google_ai_mode_app
                - microsoft_copilot_app
                - perplexity_app
        - name: region
          required: false
          in: query
          description: Repeat to select region codes. Omit for all regions.
          schema:
            example:
              - NZ:auckland
            type: array
            items:
              type: string
        - name: metric
          required: false
          in: query
          description: Which metric to break down by platform.
          schema:
            default: visibility
            type: string
            enum:
              - visibility
              - shareOfVoice
              - sentiment
              - gap
        - name: brandId
          required: false
          in: query
          description: Brand ID from the Scorecard report. Defaults to the tracked brand.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelBreakdownReportResponseDto'
        '404':
          description: Site or Brand not found.
components:
  schemas:
    ModelBreakdownReportResponseDto:
      type: object
      properties:
        data:
          nullable: true
          description: Null when the Site has no completed Scan data yet.
          type: object
          allOf:
            - $ref: '#/components/schemas/ModelBreakdownReportDataDto'
        filters:
          $ref: '#/components/schemas/AppliedPlatformRegionFiltersDto'
      required:
        - data
        - filters
    ModelBreakdownReportDataDto:
      type: object
      properties:
        brand:
          $ref: '#/components/schemas/ModelBreakdownBrandDto'
        metric:
          type: string
          enum:
            - visibility
            - shareOfVoice
            - sentiment
            - gap
          example: visibility
        platforms:
          description: >-
            One entry per platform the most recent Scan measured for the brand,
            best value first.
          type: array
          items:
            $ref: '#/components/schemas/ModelBreakdownEntryDto'
      required:
        - brand
        - metric
        - platforms
    AppliedPlatformRegionFiltersDto:
      type: object
      properties:
        platform:
          example:
            - chatgpt_app
            - chatgpt_api
          description: Platform IDs applied to the report. Empty means all.
          type: array
          items:
            type: string
        region:
          example:
            - NZ
            - AU
          description: Region codes applied to the report. Empty means all.
          type: array
          items:
            type: string
      required:
        - platform
        - region
    ModelBreakdownBrandDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Pass back as brandId to re-scope a report to this brand.
        name:
          type: string
          example: Acme
      required:
        - id
        - name
    ModelBreakdownEntryDto:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/PublicPlatformDto'
        value:
          type: number
          example: 62.5
          nullable: true
          description: >-
            Metric value on this platform. Sentiment uses the same scale as the
            Scorecard report.
      required:
        - platform
        - value
    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
  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.