> ## 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 Brand Scorecard results

> See the brand and its tracked competitors across visibility, Share of Voice, sentiment, gap, and health for each Scan. Filter by platform, region, or date.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/reports/scorecard
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/scorecard:
    get:
      tags:
        - Reports
      summary: Get Brand Scorecard results
      description: >-
        See the brand and its tracked competitors across visibility, Share of
        Voice, sentiment, gap, and health for each Scan. Filter by platform,
        region, or date.
      operationId: getScorecard
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: platform
          required: false
          in: query
          description: >-
            Repeat to select AI platforms and collection methods, for example
            ?platform=chatgpt_app&platform=chatgpt_api. Omit to include every
            platform.
          schema:
            example:
              - chatgpt_app
              - chatgpt_api
            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 regions, for example ?region=NZ&region=AU. Omit to
            include all regions.
          schema:
            example:
              - NZ
              - AU
            type: array
            items:
              type: string
        - name: startDate
          required: false
          in: query
          description: >-
            Inclusive ISO calendar-date lower bound. Omit to include all earlier
            report data.
          schema:
            type: string
            example: '2026-07-01'
        - name: endDate
          required: false
          in: query
          description: >-
            Inclusive ISO calendar-date upper bound. Omit to include all later
            report data.
          schema:
            example: '2026-07-31'
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScorecardReportResponseDto'
        '404':
          description: Site not found.
components:
  schemas:
    ScorecardReportResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardReportPointDto'
        filters:
          $ref: '#/components/schemas/AppliedReportFiltersDto'
      required:
        - data
        - filters
    ScorecardReportPointDto:
      type: object
      properties:
        date:
          type: string
          example: '2026-07-01'
        scanId:
          type: string
          format: uuid
          description: The Scan behind this point.
        brands:
          type: array
          items:
            $ref: '#/components/schemas/ScorecardBrandMetricsDto'
      required:
        - date
        - scanId
        - brands
    AppliedReportFiltersDto:
      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
        startDate:
          type: string
          nullable: true
          example: '2026-07-01'
        endDate:
          type: string
          nullable: true
          example: '2026-07-31'
      required:
        - platform
        - region
        - startDate
        - endDate
    ScorecardBrandMetricsDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Acme
        type:
          type: string
          enum:
            - brand
            - competitor
          example: brand
        visibility:
          type: number
          example: 62.5
          description: Visibility percentage.
        shareOfVoice:
          type: number
          example: 41.2
          description: Share of Voice percentage.
        sentiment:
          type: object
          example: 62
          nullable: true
          description: >-
            Average sentiment on a 0 to 100 scale (50 = neutral; runs finalized
            before the claims cutover used -100 to 100). Null when the brand has
            no sentiment evidence.
        gap:
          type: number
          example: 37.5
          description: Remaining visibility opportunity; lower is better.
        health:
          type: number
          example: 43
          description: Composite health score.
      required:
        - id
        - name
        - type
        - visibility
        - shareOfVoice
        - sentiment
        - gap
        - health
  securitySchemes:
    apiKeyAuth:
      scheme: bearer
      bearerFormat: ons_…
      type: http
      description: An API key created in Settings → Account → API Keys.

````