v1

latestOpenAPI 3.0.02026-07-222980136.7 KB

Brand Reports

List AI responses for a prompt in a brand report.

get/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

promptIdstring required

Prompt identifier within the brand report.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Prompt identifier within the brand report.

Query parameters

startDatestring required

Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.

Example:2025-01-01

Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.

endDatestring required

End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.

Example:2025-01-31

End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.

countrystring required

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

Example:us

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

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.

Response

AI responses (jobs) collected for the prompt within the window.

Example response

{
  "items": [
    {
      "runId": "01HXRUN5XY8Z2N3KQ7VAW4PAEX",
      "runDate": "2025-01-15T08:00:00.000Z",
      "engine": "chatgpt",
      "state": "completed",
      "content": "Adidas, Nike and Asics are widely cited as top picks for 2025...",
      "overviewAvailable": true,
      "brandMentions": [
        {
          "brand": "Adidas",
          "isMainBrand": true,
          "mentions": 4
        },
        {
          "brand": "Nike",
          "isMainBrand": false,
          "mentions": 3
        }
      ],
      "citations": [
        {
          "title": "Best Running Shoes of 2025",
          "link": "https://www.runnersworld.com/gear/a40081820/best-running-shoes-2025/",
          "rank": 1
        }
      ],
      "ads": [
        {
          "title": "Adidas Ultraboost",
          "url": "https://www.adidas.com/us/ultraboost",
          "image": "https://assets.adidas.com/images/ub.jpg",
          "brand": "Adidas",
          "position": 1
        }
      ],
      "shopping": [
        {
          "title": "Nike Pegasus 41",
          "image": "https://static.nike.com/peg41.jpg",
          "link": "https://www.nike.com/pegasus-41",
          "tag": "Bestseller",
          "position": 1,
          "price": "$140",
          "rating": 4.7
        }
      ],
      "webSearchQuery": [
        "best running shoes 2025",
        "top running shoes for marathon"
      ]
    }
  ],
  "paging": {
    "nextCursor": null,
    "hasMore": false
  }
}