> ## 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 AI responses for a prompt in a brand report.



## OpenAPI

````yaml https://data.otterly.ai/v1/openapi.json get /v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses
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}/ai-responses:
    get:
      tags:
        - Brand Reports
      summary: List AI responses for a prompt in 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
        - schema:
            type: string
            enum:
              - chatgpt
              - google
              - perplexity
              - copilot
              - google_ai_mode
              - gemini
              - claude
            description: Optional. Filter results to a single AI engine.
            example: chatgpt
          required: false
          description: Optional. Filter results to a single AI engine.
          name: engine
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Optional. Pagination cursor — pass back the `nextCursor` value
              from a previous response. Omit to fetch the first page.
          required: false
          description: >-
            Optional. Pagination cursor — pass back the `nextCursor` value from
            a previous response. Omit to fetch the first page.
          name: cursor
          in: query
      responses:
        '200':
          description: AI responses (jobs) collected for the prompt within the window.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiBrandReportPromptAiResponsesList'
        '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:
    PublicApiBrandReportPromptAiResponsesList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiBrandReportPromptAiResponseItem'
        paging:
          $ref: '#/components/schemas/PublicApiCursorPageInfo'
      required:
        - items
        - paging
      example:
        items:
          - runId: 01HXRUN5XY8Z2N3KQ7VAW4PAEX
            runDate: '2025-01-15T08:00:00.000Z'
            engine: chatgpt
            state: completed
            content: Adidas, Nike and Asics are widely cited as top picks for 2025...
            overviewAvailable: true
            brandMentions:
              - brand: Adidas
                isMainBrand: true
                mentions: 4
              - brand: Nike
                isMainBrand: false
                mentions: 3
            citations:
              - title: Best Running Shoes of 2025
                link: >-
                  https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/
                rank: 1
            ads:
              - title: Adidas Ultraboost
                url: https://www.adidas.com/us/ultraboost
                image: https://assets.adidas.com/images/ub.jpg
                brand: Adidas
                position: 1
            shopping:
              - title: Nike Pegasus 41
                image: https://static.nike.com/peg41.jpg
                link: https://www.nike.com/pegasus-41
                tag: Bestseller
                position: 1
                price: $140
                rating: 4.7
            webSearchQuery:
              - best running shoes 2025
              - top running shoes for marathon
        paging:
          nextCursor: null
          hasMore: false
    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
    PublicApiBrandReportPromptAiResponseItem:
      type: object
      properties:
        runId:
          type: string
          minLength: 1
          example: 01HX7K2YV9D3M8N0G6Q5R4S3T2
        runDate:
          type: string
        engine:
          type: string
          description: AI engine that produced this response.
        state:
          type: string
        content:
          type: string
        overviewAvailable:
          type: boolean
        brandMentions:
          type: array
          items:
            type: object
            properties:
              brand:
                type: string
              isMainBrand:
                type: boolean
              mentions:
                type: number
            required:
              - brand
              - isMainBrand
              - mentions
        citations:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              link:
                type: string
              rank:
                type: number
            required:
              - title
              - link
              - rank
        ads:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              url:
                type: string
              image:
                type: string
              brand:
                type: string
              position:
                type: number
            required:
              - title
              - url
        shopping:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              image:
                type: string
              link:
                type: string
              tag:
                type: string
              position:
                type: number
              price:
                type: string
              rating:
                type: number
            required:
              - title
              - image
        webSearchQuery:
          type: array
          items:
            type: string
      required:
        - runId
        - runDate
        - engine
        - state
        - content
        - overviewAvailable
        - brandMentions
        - citations
      example:
        runId: 01HXRUN5XY8Z2N3KQ7VAW4PAEX
        runDate: '2025-01-15T08:00:00.000Z'
        engine: chatgpt
        state: completed
        content: Adidas, Nike and Asics are widely cited as top picks for 2025...
        overviewAvailable: true
        brandMentions:
          - brand: Adidas
            isMainBrand: true
            mentions: 4
          - brand: Nike
            isMainBrand: false
            mentions: 3
        citations:
          - title: Best Running Shoes of 2025
            link: >-
              https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/
            rank: 1
        ads:
          - title: Adidas Ultraboost
            url: https://www.adidas.com/us/ultraboost
            image: https://assets.adidas.com/images/ub.jpg
            brand: Adidas
            position: 1
        shopping:
          - title: Nike Pegasus 41
            image: https://static.nike.com/peg41.jpg
            link: https://www.nike.com/pegasus-41
            tag: Bestseller
            position: 1
            price: $140
            rating: 4.7
        webSearchQuery:
          - best running shoes 2025
          - top running shoes for marathon
    PublicApiCursorPageInfo:
      type: object
      properties:
        nextCursor:
          type: string
          nullable: true
        hasMore:
          type: boolean
      required:
        - nextCursor
        - hasMore
      example:
        nextCursor: null
        hasMore: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Provide your API key as a Bearer token: `Authorization: Bearer
        YOUR_API_KEY`.

````