OTotterly
Brand Reports

List prompts for a brand report

Changed on
get/v1/reports/brand/{reportId}/prompts

Request

  • Base URL
    https://data.otterly.ai
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Query parameters

startDatestring required

Start date for the prompts window (inclusive).

Example:2025-01-01
endDatestring required

End date for the prompts window (inclusive).

Example:2025-01-31
countrystring required

Country code to filter prompts by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Example:us
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.

Example:weekly
'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude'

AI engine identifier.

OR
string[]
Example:chatgpt
tagIdstring

Optional. Filter prompts by tag id.

searchstring

Optional. Free-text search.

offsetinteger

Optional. Zero-based offset for pagination; must be a multiple of limit. Defaults to 0.

limitinteger

Optional. Maximum number of items to return.

sortBystring

Optional. Field to sort by.

sortOrder'asc' | 'desc'

Optional. Sort direction.

brandMentionedboolean

Optional. Filter prompts where the brand is mentioned.

string
OR
string[]
'Social Media' | 'Community/Forum' | 'Brand' | 'Encyclopedia' | 'News/Media' | 'Blogs/Personal Sites' | 'Government/NGO' | 'Education' | 'Video' | 'Competitor' | 'Others' | 'Unclassified'

Domain classification.

OR
string[]
Example:News/Media
string
OR
string[]

Response

A page of prompts for the brand report.

Example response

{
  "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,
    "hasMore": true
  }
}

Changes