Skip to main content
GET
/
v1
/
reports
/
brand
/
{reportId}
/
prompts
/
{promptId}
Get prompt details from a brand report.
curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/prompts/{promptId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
  "reportId": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
  "prompt": "best running shoes 2025",
  "intentVolume": 12500,
  "brandCoverageHistory": [
    {
      "brand": "Adidas",
      "coverage": 0.42,
      "date": "2025-01-15"
    }
  ],
  "brandRank": [
    {
      "brand": "Adidas",
      "rank": 1,
      "mentions": 1705,
      "brandCoverage": 0.42,
      "sentiment": {
        "positive": 0.6,
        "neutral": 0.3,
        "negative": 0.1,
        "nss": 0.5
      }
    }
  ],
  "domainCategories": [
    {
      "category": "News/Media",
      "value": 18
    },
    {
      "category": "Brand",
      "value": 7
    }
  ],
  "brandReports": [
    {
      "id": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
      "brand": "Adidas",
      "brandDomain": "adidas.com",
      "reportTitle": "Adidas Visibility Report"
    }
  ],
  "tags": [
    {
      "id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
      "name": "Running Shoes",
      "color": "orange"
    }
  ]
}

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"

Response

Details for the prompt within the brand report.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

reportId
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

prompt
string
required
intentVolume
number
required
brandCoverageHistory
object[]
required
brandRank
object[]
required
domainCategories
object[]
required
brandReports
object[]
required
tags
object[]
required