Skip to main content
GET
/
v1
/
reports
/
brand
/
{reportId}
/
prompts
/
{promptId}
/
ai-responses
List AI responses for a prompt in a brand report.
curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId}/ai-responses \
  --header 'Authorization: Bearer <token>'
{
  "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
        }
      ]
    }
  ],
  "paging": {
    "nextCursor": null,
    "hasMore": false
  }
}

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"

​
promptId
string
required

Prompt identifier within the brand report.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

​
startDate
string
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.

Minimum string length: 1
Example:

"2025-01-01"

​
endDate
string
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.

Minimum string length: 1
Example:

"2025-01-31"

​
country
string
required

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

Minimum string length: 1
Example:

"us"

​
cursor
string

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

Minimum string length: 1

Response

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

​
items
object[]
required
​
paging
object
required
Example:
{ "nextCursor": null, "hasMore": false }