> ## 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 a recommendation

> One recommendation: its brief (what to do and why), the standing history, and the evidence quotes.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/sites/{siteId}/recommendations/{recommendationId}
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}/recommendations/{recommendationId}:
    get:
      tags:
        - Sites
      summary: Get a recommendation
      description: >-
        One recommendation: its brief (what to do and why), the standing
        history, and the evidence quotes.
      operationId: getRecommendation
      parameters:
        - name: siteId
          required: true
          in: path
          schema:
            type: string
        - name: recommendationId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationDetailResponseDto'
        '404':
          description: Recommendation not found.
components:
  schemas:
    RecommendationDetailResponseDto:
      type: object
      properties:
        recommendationId:
          type: string
          format: uuid
        title:
          type: string
        question:
          type: string
        topic:
          type: string
        status:
          type: string
          enum:
            - review
            - approved
            - underway
            - validate
            - closed
            - archived
        targetStanding:
          type: number
          example: 3
        brief:
          type: object
          description: 'The structured brief: answer, shortfall, proposed work.'
        standing:
          $ref: '#/components/schemas/RecommendationStandingHistoryDto'
        evidence:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationEvidenceDto'
      required:
        - recommendationId
        - title
        - question
        - topic
        - status
        - targetStanding
        - brief
        - standing
        - evidence
    RecommendationStandingHistoryDto:
      type: object
      properties:
        baseline:
          type: number
          nullable: true
        current:
          type: number
          nullable: true
        previous:
          type: number
          nullable: true
        change:
          type: string
          nullable: true
      required:
        - baseline
        - current
        - previous
        - change
    RecommendationEvidenceDto:
      type: object
      properties:
        ordinal:
          type: number
        role:
          type: string
          example: representative_quote
        quote:
          type: string
          nullable: true
        platform:
          type: string
          nullable: true
          example: chatgpt_app
          description: >-
            Platform id; null when the evidence came from a model the API no
            longer names.
        region:
          type: string
          nullable: true
        promptText:
          type: string
          nullable: true
          description: The prompt behind the evidence.
      required:
        - ordinal
        - role
        - quote
        - platform
        - region
        - promptText
  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.