RankrRankr/Documentation
Menu
Brands

Summary rollup

One-call snapshot for a time window — visibility %, average sentiment, mentions per provider, top competitors. Designed so an agent can answer "how is my brand doing" in a single tool call. Responses are JSON and require a workspace API key.

GET/v1/brands/{brand_id}/summary
Requires API key

Parameters

brand_iduuid· pathrequired

Brand to summarize.

windowstring· queryoptional

Rollup window. Default 30d.

7d30d90d
Request
curl -X GET 'https://api.rankr.so/v1/brands/:brand_id/summary' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Response200
JSON
{
  "window": "30d",
  "visibility_pct": 62,
  "avg_sentiment": 74,
  "total_mentions": 412,
  "mentions_by_provider": {
    "openai": 181,
    "anthropic": 104,
    "gemini": 78,
    "perplexity": 49
  },
  "top_competitors": [
    {
      "name": "Globex",
      "mentions": 57,
      "sentiment": 68
    },
    {
      "name": "Initech",
      "mentions": 41,
      "sentiment": 72
    }
  ],
  "prompts_tracked": 24,
  "generated_at": "2026-04-20T09:32:00Z"
}