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

# List prompts for a brand report



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/prompts
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:
    get:
      tags:
        - Brand Reports
      summary: List prompts for 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
            description: Start date for the prompts window (inclusive).
            example: '2025-01-01'
          required: true
          description: Start date for the prompts window (inclusive).
          name: startDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: End date for the prompts window (inclusive).
            example: '2025-01-31'
          required: true
          description: End date for the prompts window (inclusive).
          name: endDate
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2;
              use `uk` for the United Kingdom.
            example: us
          required: true
          description: >-
            Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2; use
            `uk` for the United Kingdom.
          name: country
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - chatgpt
                  - google
                  - perplexity
                  - copilot
                  - google_ai_mode
                  - gemini
                  - claude
                description: AI engine identifier.
                example: chatgpt
              - type: array
                items:
                  type: string
                  enum:
                    - chatgpt
                    - google
                    - perplexity
                    - copilot
                    - google_ai_mode
                    - gemini
                    - claude
                  description: AI engine identifier.
                  example: chatgpt
            description: >-
              Optional. AI engine(s) to filter by. Repeat the param or pass a
              single value.
          required: false
          description: >-
            Optional. AI engine(s) to filter by. Repeat the param or pass a
            single value.
          name: engines
          in: query
        - schema:
            type: string
            description: Optional. Filter prompts by tag id.
          required: false
          description: Optional. Filter prompts by tag id.
          name: tagId
          in: query
        - schema:
            type: string
            description: Optional. Free-text search.
          required: false
          description: Optional. Free-text search.
          name: search
          in: query
        - schema:
            type: integer
            description: Optional. Zero-based offset for pagination.
          required: false
          description: Optional. Zero-based offset for pagination.
          name: offset
          in: query
        - schema:
            type: integer
            description: Optional. Maximum number of items to return.
          required: false
          description: Optional. Maximum number of items to return.
          name: limit
          in: query
        - schema:
            type: string
            description: Optional. Field to sort by.
          required: false
          description: Optional. Field to sort by.
          name: sortBy
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            description: Optional. Sort direction.
          required: false
          description: Optional. Sort direction.
          name: sortOrder
          in: query
        - schema:
            type: boolean
            description: Optional. Filter prompts where the brand is mentioned.
          required: false
          description: Optional. Filter prompts where the brand is mentioned.
          name: brandMentioned
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: Optional. Filter by one or more competitor brand names.
          required: false
          description: Optional. Filter by one or more competitor brand names.
          name: competitors
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - Social Media
                  - Community/Forum
                  - Brand
                  - Encyclopedia
                  - News/Media
                  - Blogs/Personal Sites
                  - Government/NGO
                  - Education
                  - Video
                  - Competitor
                  - Others
                  - Unclassified
                description: Domain classification.
                example: News/Media
              - type: array
                items:
                  type: string
                  enum:
                    - Social Media
                    - Community/Forum
                    - Brand
                    - Encyclopedia
                    - News/Media
                    - Blogs/Personal Sites
                    - Government/NGO
                    - Education
                    - Video
                    - Competitor
                    - Others
                    - Unclassified
                  description: Domain classification.
                  example: News/Media
            description: >-
              Optional. Domain category/categories to filter by. Repeat the
              param or pass a single value.
          required: false
          description: >-
            Optional. Domain category/categories to filter by. Repeat the param
            or pass a single value.
          name: domainCategories
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: Optional. Filter prompts to specific domains.
          required: false
          description: Optional. Filter prompts to specific domains.
          name: domains
          in: query
      responses:
        '200':
          description: A page of prompts for the brand report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBrandReportPromptsList'
        '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 not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PublicApiBrandReportPromptsList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportPromptSearchVolumeItem'
        paging:
          $ref: '#/components/schemas/PublicApiOffsetPaging'
      required:
        - items
        - paging
      example:
        items:
          - rank: 1
            id: 01HXP1DRTM5G8Z2N3KQ7VAW4PA
            country: us
            prompt: best running shoes 2025
            volume: 12500
            brandMentions: 1705
            domainMentions: 858
            adsShare: 21
            shoppingShare: 30
            tags:
              - id: 01HX8AB3CDE4FG5HJ6KL7MN8PQ
                name: Running Shoes
                color: orange
              - id: 01KEKGEXZFX118K4C2NTMBN0TX
                name: Funnel - BoFu
                color: gold
            competitors:
              - brand: Nike
                brandMentions: 1331
                domainMentions: 66
              - brand: Asics
                brandMentions: 891
                domainMentions: 77
              - brand: New Balance
                brandMentions: 473
                domainMentions: 0
        paging:
          limit: 25
          offset: 0
    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
    PublicApiBrandReportPromptSearchVolumeItem:
      type: object
      properties:
        rank:
          type: number
        id:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        country:
          type: string
        prompt:
          type: string
        volume:
          type: number
        brandMentions:
          type: number
        domainMentions:
          type: number
        adsShare:
          type: number
        shoppingShare:
          type: number
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportTag'
        competitors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportPromptCompetitor'
      required:
        - rank
        - id
        - country
        - prompt
        - volume
        - brandMentions
        - domainMentions
      example:
        rank: 1
        id: 01HXP1DRTM5G8Z2N3KQ7VAW4PA
        country: us
        prompt: best running shoes 2025
        volume: 12500
        brandMentions: 1705
        domainMentions: 858
        adsShare: 21
        shoppingShare: 30
        tags:
          - id: 01HX8AB3CDE4FG5HJ6KL7MN8PQ
            name: Running Shoes
            color: orange
          - id: 01KEKGEXZFX118K4C2NTMBN0TX
            name: Funnel - BoFu
            color: gold
        competitors:
          - brand: Nike
            brandMentions: 1331
            domainMentions: 66
          - brand: Asics
            brandMentions: 891
            domainMentions: 77
          - brand: New Balance
            brandMentions: 473
            domainMentions: 0
    PublicApiOffsetPaging:
      type: object
      properties:
        limit:
          type: integer
          minimum: 1
        offset:
          type: integer
          minimum: 0
      required:
        - limit
        - offset
      example:
        limit: 25
        offset: 0
    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
    PublicApiBrandReportPromptCompetitor:
      type: object
      properties:
        brand:
          type: string
        brandMentions:
          type: number
        domainMentions:
          type: number
      required:
        - brand
        - brandMentions
        - domainMentions
      example:
        brand: Nike
        brandMentions: 1331
        domainMentions: 66
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````