Skip to main content
GET
/
v1
/
reports
/
brand
/
{reportId}
/
stats
Get statistics for a brand report
curl --request GET \
  --url https://data.otterly.ai/v1/reports/brand/{reportId}/stats \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "<string>",
  "isRecalculating": true,
  "totalPrompts": 1,
  "brand": {
    "brand": "<string>",
    "brandDomain": "<string>",
    "brandDomainWildcard": true
  },
  "summary": {
    "averageRank": 123,
    "averagePosition": 123,
    "totalMentions": 1,
    "totalSources": 1,
    "shareOfVoice": 123,
    "brandCoverage": 123,
    "domainCoverage": 123
  },
  "detectedBrands": [
    {
      "name": "<string>",
      "mentions": 123
    }
  ],
  "allBrandsAnalysis": {
    "brandMentions": [
      {
        "brand": "<string>",
        "isMainBrand": true,
        "rank": 123,
        "mentions": 123,
        "shareOfVoice": 123,
        "brandCoverage": 123
      }
    ],
    "brandRankHistory": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "rank": 123
          }
        ]
      }
    ],
    "brandCoverageHistory": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "logoUrl": "<string>",
            "coverage": 123
          }
        ]
      }
    ],
    "brandPositionHistory": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "position": 123
          }
        ]
      }
    ],
    "brandVisibilityIndex": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "visibilityScore": 123,
            "brandCoverage": 123,
            "likelihoodToBuy": 123
          }
        ]
      }
    ],
    "domainCoverageHistory": [
      {
        "date": "<string>",
        "domains": [
          {
            "domain": "<string>",
            "isMainBrand": true,
            "logoUrl": "<string>",
            "coverage": 123
          }
        ]
      }
    ]
  },
  "competitorBrandsAnalysis": {
    "brandMentions": [
      {
        "brand": "<string>",
        "domain": "<string>",
        "logoUrl": "<string>",
        "isMainBrand": true,
        "mentions": 123,
        "shareOfVoice": 123,
        "brandCoverage": 123,
        "domainCoverage": 123,
        "domainCitations": 123,
        "averageRank": 123,
        "averagePosition": 123,
        "visibilityScore": 123,
        "likelihoodToBuy": 123,
        "sentiment": {
          "positive": 123,
          "neutral": 123,
          "negative": 123,
          "nss": 123
        }
      }
    ],
    "brandCoverageHistory": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "logoUrl": "<string>",
            "coverage": 123
          }
        ]
      }
    ],
    "domainCoverageHistory": [
      {
        "date": "<string>",
        "domains": [
          {
            "domain": "<string>",
            "isMainBrand": true,
            "logoUrl": "<string>",
            "coverage": 123
          }
        ]
      }
    ],
    "brandVisibilityIndex": [
      {
        "date": "<string>",
        "brands": [
          {
            "brand": "<string>",
            "isMainBrand": true,
            "visibilityScore": 123,
            "brandCoverage": 123,
            "likelihoodToBuy": 123
          }
        ]
      }
    ]
  }
}

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"

Query Parameters

startDate
string
required

Start date for the stats window (inclusive).

Minimum string length: 1
Example:

"2025-01-01"

endDate
string
required

End date for the stats window (inclusive).

Minimum string length: 1
Example:

"2025-01-31"

country
string
required

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

Minimum string length: 1
Example:

"us"

engines

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

Available options:
chatgpt,
google,
perplexity,
copilot,
google_ai_mode,
gemini
Example:

"chatgpt"

tagId
string

Optional. Filter stats by tag id.

Response

Statistics for the brand report.

Brand report stats payload: meta, the tracked brand info, summary metrics, detected source brands, and per-analysis aggregates (all detected brands vs configured competitors).

id
string
required
status
string
required
isRecalculating
boolean
required
totalPrompts
integer
required
Required range: x >= 0
brand
object
required
summary
object
required
detectedBrands
object[]
required
allBrandsAnalysis
object
required
competitorBrandsAnalysis
object
required