> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otterly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get prompt details from a brand report.



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/prompts/{promptId}
openapi: 3.0.0
info:
  title: Otterly Public API
  version: 1.0.0
servers:
  - url: https://data.otterly.ai
security: []
tags:
  - name: Engines
  - name: Workspaces
  - name: Brand Reports
  - name: Audits
  - name: Accounts
paths:
  /v1/reports/brand/{reportId}/prompts/{promptId}:
    get:
      tags:
        - Brand Reports
      summary: Get prompt details from a brand report.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
            description: Brand report identifier.
          required: true
          description: Brand report identifier.
          name: reportId
          in: path
        - schema:
            type: string
            minLength: 1
            example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
            description: Prompt identifier within the brand report.
          required: true
          description: Prompt identifier within the brand report.
          name: promptId
          in: path
        - schema:
            type: string
            minLength: 1
            description: >-
              Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD`
              or a full ISO timestamp; only the date portion is used and the
              window is anchored at `00:00:00.000Z`.
            example: '2025-01-01'
          required: true
          description: >-
            Start date for the lookup window (inclusive). Accepts `YYYY-MM-DD`
            or a full ISO timestamp; only the date portion is used and the
            window is anchored at `00:00:00.000Z`.
          name: startDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              End date for the lookup window (inclusive). Accepts `YYYY-MM-DD`
              or a full ISO timestamp; only the date portion is used and the
              window is anchored at `23:59:59.999Z`.
            example: '2025-01-31'
          required: true
          description: >-
            End date for the lookup window (inclusive). Accepts `YYYY-MM-DD` or
            a full ISO timestamp; only the date portion is used and the window
            is anchored at `23:59:59.999Z`.
          name: endDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk`
              for the United Kingdom.
            example: us
          required: true
          description: >-
            Country code to filter by. Lowercase ISO 3166-1 alpha-2; use `uk`
            for the United Kingdom.
          name: country
          in: query
      responses:
        '200':
          description: Details for the prompt within the brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBrandReportPromptDetail'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiValidationErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        '404':
          description: Report or prompt not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PublicApiBrandReportPromptDetail:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        reportId:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        prompt:
          type: string
        intentVolume:
          type: number
        brandCoverageHistory:
          type: array
          items:
            type: object
            properties:
              brand:
                type: string
              coverage:
                type: number
              date:
                type: string
            required:
              - brand
              - coverage
              - date
        brandRank:
          type: array
          items:
            type: object
            properties:
              brand:
                type: string
              rank:
                type: number
              mentions:
                type: number
              brandCoverage:
                type: number
              sentiment:
                type: object
                properties:
                  positive:
                    type: number
                  neutral:
                    type: number
                  negative:
                    type: number
                  nss:
                    type: number
                required:
                  - positive
                  - neutral
                  - negative
                  - nss
            required:
              - brand
              - rank
              - mentions
              - brandCoverage
        domainCategories:
          type: array
          items:
            type: object
            properties:
              category:
                type: string
              value:
                type: number
            required:
              - category
              - value
        brandReports:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportPromptBrandReportRef'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportTag'
      required:
        - id
        - reportId
        - prompt
        - intentVolume
        - brandCoverageHistory
        - brandRank
        - domainCategories
        - brandReports
        - tags
      example:
        id: 01HXP1DRTM5G8Z2N3KQ7VAW4PA
        reportId: 01HXBR1DGM5XY8Z2N3KQ7VAW4P
        prompt: best running shoes 2025
        intentVolume: 12500
        brandCoverageHistory:
          - brand: Adidas
            coverage: 0.42
            date: '2025-01-15'
        brandRank:
          - brand: Adidas
            rank: 1
            mentions: 1705
            brandCoverage: 0.42
            sentiment:
              positive: 0.6
              neutral: 0.3
              negative: 0.1
              nss: 0.5
        domainCategories:
          - category: News/Media
            value: 18
          - category: Brand
            value: 7
        brandReports:
          - id: 01HXBR1DGM5XY8Z2N3KQ7VAW4P
            brand: Adidas
            brandDomain: adidas.com
            reportTitle: Adidas Visibility Report
        tags:
          - id: 01HX8AB3CDE4FG5HJ6KL7MN8PQ
            name: Running Shoes
            color: orange
    PublicApiValidationErrorResponse:
      type: object
      properties:
        message:
          type: string
        target:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
              - code
      required:
        - message
        - target
        - errors
      example:
        message: Validation failed
        target: query
        errors:
          - path: country
            message: Required
            code: invalid_type
    PublicApiErrorResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      example:
        message: Report not found
    PublicApiBrandReportPromptBrandReportRef:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        brand:
          type: string
        brandDomain:
          type: string
        reportTitle:
          type: string
      required:
        - id
        - brand
        - brandDomain
      example:
        id: 01HXBR1DGM5XY8Z2N3KQ7VAW4P
        brand: Adidas
        brandDomain: adidas.com
        reportTitle: Adidas Visibility Report
    PublicApiBrandReportTag:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        name:
          type: string
        color:
          type: string
          description: >-
            Tag color (Ant Design preset color name, e.g. 'gold', 'orange',
            'magenta', 'green', 'blue').
      required:
        - id
        - name
        - color
      example:
        id: 01HX8AB3CDE4FG5HJ6KL7MN8PQ
        name: Running Shoes
        color: orange
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````