Skip to main content
GET
/
v1
/
reports
/
brand
/
{reportId}
/
prompts
List prompts for a brand report
curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "rank": 1,
      "id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
      "country": "us",
      "prompt": "best running shoes 2025",
      "volume": 12500,
      "brandMentions": 1705,
      "domainMentions": 858,
      "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
  }
}

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.

Authorizations

​
Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

​
reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

​
startDate
string
required

Start date for the prompts window (inclusive).

Minimum string length: 1
Example:

"2025-01-01"

​
endDate
string
required

End date for the prompts window (inclusive).

Minimum string length: 1
Example:

"2025-01-31"

​
country
string
required

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

Minimum string length: 1
Example:

"us"

​
engines

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

Available options:
chatgpt,
google,
perplexity,
copilot,
google_ai_mode,
gemini
Example:

"chatgpt"

​
tagId
string

Optional. Filter prompts by tag id.

​
search
string

Optional. Free-text search.

​
offset
integer

Optional. Zero-based offset for pagination.

​
limit
integer

Optional. Maximum number of items to return.

​
sortBy
string

Optional. Field to sort by.

​
sortOrder
enum<string>

Optional. Sort direction.

Available options:
asc,
desc
​
brandMentioned
boolean

Optional. Filter prompts where the brand is mentioned.

​
competitors

Optional. Filter by one or more competitor brand names.

​
domainCategories

Optional. Domain category/categories to filter by. Repeat the param or pass a single value.

Available options:
Social Media,
Community/Forum,
Brand,
Encyclopedia,
News/Media,
Blogs/Personal Sites,
Government/NGO,
Education,
Video,
Competitor,
Others,
Unclassified
Example:

"News/Media"

​
domains

Optional. Filter prompts to specific domains.

Response

A page of prompts for the brand report.

​
items
object[]
required
​
paging
object
required
Example:
{ "limit": 25, "offset": 0 }