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

> The Site's current recommendations, filterable by platform, region, persona, product, stage, brand-mention, narrative, board status, and movement since the last Scan. Each carries its prompt references by Scan; open one for its brief and evidence.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/reports/recommendations
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/recommendations:
    get:
      tags:
        - Reports
      summary: List recommendations
      description: >-
        The Site's current recommendations, filterable by platform, region,
        persona, product, stage, brand-mention, narrative, board status, and
        movement since the last Scan. Each carries its prompt references by
        Scan; open one for its brief and evidence.
      operationId: listRecommendations
      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
          schema:
            example:
              - NZ:auckland
            type: array
            items:
              type: string
        - name: persona
          required: false
          in: query
          schema:
            example:
              - homeowners
            type: array
            items:
              type: string
        - name: product
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
        - name: stage
          required: false
          in: query
          schema:
            example:
              - Decision
            type: array
            items:
              type: string
        - name: brandMention
          required: false
          in: query
          schema:
            type: string
            enum:
              - mentions_tracked_brand
              - does_not_mention_tracked_brand
        - name: narrativeId
          required: false
          in: query
          schema:
            type: string
            format: uuid
        - name: status
          required: false
          in: query
          description: Board stage. Repeat to select several.
          schema:
            type: array
            items:
              type: string
              enum:
                - review
                - approved
                - underway
                - validate
                - closed
                - archived
        - name: movement
          required: false
          in: query
          description: Change since the last Scan. Repeat to select several.
          schema:
            type: array
            items:
              type: string
              enum:
                - new
                - updated
                - stable
                - improved
                - regressed
                - needs_review
                - ready
                - proven
                - declined
                - archived
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationsListResponseDto'
components:
  schemas:
    RecommendationsListResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationDto'
      required:
        - data
    RecommendationDto:
      type: object
      properties:
        recommendationId:
          type: string
          format: uuid
        title:
          type: string
        topic:
          type: string
        question:
          type: string
        type:
          type: string
          enum:
            - visibility
            - sentiment
            - narrative
            - authority
            - defend
        status:
          type: string
          enum:
            - review
            - approved
            - underway
            - validate
            - closed
            - archived
          description: Board stage.
        movement:
          type: string
          enum:
            - new
            - updated
            - stable
            - improved
            - regressed
            - needs_review
            - ready
            - proven
            - declined
            - archived
          description: Change since last Scan.
        impact:
          type: string
          enum:
            - high
            - medium
            - low
        effort:
          type: string
          enum:
            - high
            - medium
            - low
        confidence:
          type: string
          enum:
            - high
            - medium
            - low
        standing:
          $ref: '#/components/schemas/RecommendationStandingDto'
        scope:
          $ref: '#/components/schemas/RecommendationScopeDto'
        narrative:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/RecommendationNarrativeDto'
        prompts:
          description: Prompt refs by Scan.
          type: array
          items:
            $ref: '#/components/schemas/RecommendationPromptRefDto'
        publishedAt:
          type: string
          nullable: true
        updatedAt:
          type: string
          nullable: true
      required:
        - recommendationId
        - title
        - topic
        - question
        - type
        - status
        - movement
        - impact
        - effort
        - confidence
        - standing
        - scope
        - narrative
        - prompts
        - publishedAt
        - updatedAt
    RecommendationStandingDto:
      type: object
      properties:
        target:
          type: number
          example: 3
          description: Target rung (0 Absent … 4 Recommended).
        current:
          type: number
          nullable: true
        baseline:
          type: number
          nullable: true
      required:
        - target
        - current
        - baseline
    RecommendationScopeDto:
      type: object
      properties:
        modelId:
          type: string
          nullable: true
        region:
          type: string
          nullable: true
        personas:
          type: array
          items:
            type: string
        products:
          type: array
          items:
            type: string
        journeyStageId:
          type: string
          nullable: true
        promptKind:
          type: string
          example: all
      required:
        - modelId
        - region
        - personas
        - products
        - journeyStageId
        - promptKind
    RecommendationNarrativeDto:
      type: object
      properties:
        narrativeId:
          type: string
          format: uuid
        name:
          type: string
      required:
        - narrativeId
        - name
    RecommendationPromptRefDto:
      type: object
      properties:
        promptId:
          type: string
          format: uuid
          description: Resolve via GET …/prompts/{promptId}.
        firstScanId:
          type: string
          format: uuid
          nullable: true
        lastObservedScanId:
          type: string
          format: uuid
          nullable: true
        tracked:
          type: boolean
      required:
        - promptId
        - firstScanId
        - lastObservedScanId
        - tracked
  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.