competitive_overview
Snapshot of ONE competitive metric vs your tracked competitors within a segment: AI Overviews on-SERP market share, featured snippets, brand mentions, ranked keywords, or ranked pages. Its ai_overviews metric is Google AI Overviews inclusion (the on-SERP answer box) — NOT ChatGPT/Perplexity/Gemini citations (use ai_visibility_* for those). You vs each competitor for the chosen metric, optionally period-over-period. Segment-level snapshots only (no keyword/page/category drill in v1). Defaults to the primary 'default' (Overall Market) segment when omitted — name another tracked segment to scope to it.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"metric": "<metric>",
"date_range": "<date_range>"
},
"name": "competitive_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vs | No | Optionally ALSO plot one of YOUR metrics — clicks, impressions, CTR or average position — on a right axis, joined to the competitive metric on the same period (like the QWA "Market Share v/s Clicks" chart). Whole-domain only: can be joined ONLY on the default segment (which spans the whole domain). Omit for the competitive metric alone. | |
| page | No | NOT supported in v1 — page drill is rejected (segment-level snapshots only). | |
| brand | No | Restrict to branded ("Yes") or non-branded ("No") demand | |
| grain | No | Granularity — only segment-level is supported in v1; keyword/page are rejected. | |
| top_n | No | Max competitors to read for long-domain families | |
| device | No | Filter by device, e.g. "MOBILE" or "DESKTOP" | |
| intent | No | Restrict to ONE search intent (a customer keyword group) | |
| medium | No | competitor source medium, e.g. "google/organic" (default) or "google/cpc" | |
| metric | Yes | Which competitive metric family to snapshot vs competitors: featured_snippets, ai_overviews (Google AI Overviews inclusion), brand_mentions, ranked_keywords, ranked_pages. | |
| country | No | Filter by country code, e.g. "usa" | |
| metrics | No | Opt-in sub-metric keys within the family (e.g. ["negative_mentions"] for brand_mentions). Defaults to the family's default sub-metrics. Unknown keys are rejected with the valid list. | |
| segment | No | Tracked segment ID; omit to use the primary "default" (Overall Market) segment. | |
| category | No | NOT supported in v1 — category drill is rejected (segment-level snapshots only). | |
| competitor | No | Optional single competitor domain/label to focus on | |
| date_range | Yes | Explicit date range, e.g. "2026-05-01 to 2026-05-31". Both endpoints are INCLUSIVE — the END day is covered (a 7-day range = 7 days). Quattr weeks run Sunday–Saturday; for "last week" use the most recent complete Sun–Sat span. | |
| comparison_range | No | Explicit comparison range for period-over-period, e.g. "2026-04-01 to 2026-04-30" |