Sign in

v1

latestOpenAPI 3.0.02026-07-222980136.7 KB
Brand Reports

List recommendations for a brand report

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

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

Query parameters

countrystring required

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

Example:us

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

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

Optional. Filter results to a single AI engine.

Example:chatgpt

Optional. Filter results to a single AI engine.

cursorstring

Optional. Pagination cursor — pass back the nextCursor value from a previous response. Omit to fetch the first page.

Optional. Pagination cursor — pass back the nextCursor value from a previous response. Omit to fetch the first page.

Response

A list of recommendations for the brand report.

Example response

{
  "items": [
    {
      "id": "1072ee8791164402a29207d96bfb036ca43e85dd1c0678e8899cb0caa96f655c",
      "engine": "chatgpt",
      "type": "content_partnership_opportunities",
      "group": "off_page",
      "priority": 6,
      "score": 261,
      "state": "suggested",
      "data": {
        "url": "https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/",
        "title": "Best Running Shoes of 2025, Tested & Reviewed",
        "domain": "runnersworld.com",
        "domainCategory": "News/Media",
        "mentionedCompetitors": [
          "Nike",
          "Asics",
          "New Balance"
        ],
        "citations": 7,
        "prompts": [
          {
            "promptId": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
            "prompt": "best running shoes 2025"
          }
        ],
        "country": "us",
        "service": "chatgpt",
        "type": "content_partnership_opportunities"
      }
    }
  ],
  "paging": {
    "nextCursor": null,
    "hasMore": false
  }
}