Sign in

v1

latestOpenAPI 3.0.02026-07-222980136.7 KB
Brand Reports

List prompts for a brand report

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

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

Query parameters

startDatestring required

Start date for the prompts window (inclusive).

Example:2025-01-01

Start date for the prompts window (inclusive).

endDatestring required

End date for the prompts window (inclusive).

Example:2025-01-31

End date for the prompts window (inclusive).

countrystring required

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

Example:us

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

'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude'

AI engine identifier.

OR
string[]
Example:chatgpt

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

tagIdstring

Optional. Filter prompts by tag id.

Optional. Filter prompts by tag id.

searchstring

Optional. Free-text search.

Optional. Free-text search.

offsetinteger

Optional. Zero-based offset for pagination.

Optional. Zero-based offset for pagination.

limitinteger

Optional. Maximum number of items to return.

Optional. Maximum number of items to return.

sortBystring

Optional. Field to sort by.

Optional. Field to sort by.

sortOrder'asc' | 'desc'

Optional. Sort direction.

Optional. Sort direction.

brandMentionedboolean

Optional. Filter prompts where the brand is mentioned.

Optional. Filter prompts where the brand is mentioned.

string
OR
string[]

Optional. Filter by one or more competitor brand names.

'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

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

string
OR
string[]

Optional. Filter prompts to specific domains.

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
  }
}