---
title: "List prompts for a brand report"
method: GET
path: "/v1/reports/brand/{reportId}/prompts"
tags: ["Brand Reports"]
---

# List prompts for a brand report

`GET /v1/reports/brand/{reportId}/prompts`

## Request

- Base URL: `https://data.otterly.ai`
- URL: `https://data.otterly.ai/v1/reports/brand/{reportId}/prompts`
- Auth: HTTP bearer

## Path parameters

- `reportId` string, required: Brand report identifier.

## Query parameters

- `startDate` string, required: Start date for the prompts window (inclusive).
- `endDate` string, required: End date for the prompts window (inclusive).
- `country` string, required: Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2; use `uk` for the United Kingdom.
- `frequency` 'daily' | 'weekly': Optional. `weekly` buckets the periods by ISO week (a weekly run lands on its week's Monday; the current, unfinished week is left out). Defaults to `weekly` for a workspace monitored weekly, otherwise `daily`.
- `engines` union: Optional. AI engine(s) to filter by. Repeat the param or pass a single value.
  - 'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude': AI engine identifier.
  - string[]
- `tagId` string: Optional. Filter prompts by tag id.
- `search` string: Optional. Free-text search.
- `offset` integer: Optional. Zero-based offset for pagination; must be a multiple of `limit`. Defaults to 0.
- `limit` integer: Optional. Maximum number of items to return.
- `sortBy` string: Optional. Field to sort by.
- `sortOrder` 'asc' | 'desc': Optional. Sort direction.
- `brandMentioned` boolean: Optional. Filter prompts where the brand is mentioned.
- `competitors` union: Optional. Filter by one or more competitor brand names.
  - string
  - string[]
- `domainCategories` union: Optional. Domain category/categories to filter by. Repeat the param or pass a single value.
  - 'Social Media' | 'Community/Forum' | 'Brand' | 'Encyclopedia' | 'News/Media' | 'Blogs/Personal Sites' | 'Government/NGO' | 'Education' | 'Video' | 'Competitor' | 'Others' | 'Unclassified': Domain classification.
  - string[]
- `domains` union: Optional. Filter prompts to specific domains.
  - string
  - string[]

## Response `200`

A page of prompts for the brand report.

- PublicApiBrandReportPromptsList
  - `items` PublicApiBrandReportPromptSearchVolumeItem[], required
    - `rank` number, required
    - `id` string, required
    - `country` string, required
    - `prompt` string, required
    - `volume` number, required
    - `brandMentions` number, required
    - `domainMentions` number, required
    - `adsShare` number
    - `shoppingShare` number
    - `tags` PublicApiBrandReportTag[]
      - `id` string, required
      - `name` string, required
      - `color` string, required: Tag color (Ant Design preset color name, e.g. 'gold', 'orange', 'magenta', 'green', 'blue').
    - `competitors` PublicApiBrandReportPromptCompetitor[]
      - `brand` string, required
      - `brandMentions` number, required
      - `domainMentions` number, required
  - `paging` PublicApiOffsetPaging, required
    - `limit` integer, required
    - `offset` integer, required
    - `hasMore` boolean, required: True when a further page exists at `offset + limit`.

## Other responses

- `400`: Validation failed.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Report not found.

## Changes

- **2026-11-05** `333e3100f0b4`: 1 info
  - added the new optional `query` request parameter `frequency`
- **2026-11-03** `b5dc4bea6d45`: 1 info
  - added the required property `paging/hasMore` to the response with the `200` status

[Operation history](https://skmtc.dev/otterly/apis/otterly-public-api/changes/v1/reports/brand/:reportId/prompts/get.md)

---

[API](https://skmtc.dev/otterly/apis/otterly-public-api.md) - [All operations](https://skmtc.dev/otterly/apis/otterly-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/otterly/apis/otterly-public-api/revisions/333e3100f0b4?raw)