Get Competitors
get-competitorsBrands the AI platforms name for the tracked questions. dataset=ranking (default) returns one row per brand for the period, own brand included, ranked by visibility with mentions, citations, average position, per-platform numbers and a few deduplicated highlights of what platforms say about each brand. dataset=detail returns one brand (name fragment in "competitor") with all its highlights. dataset=history returns the stored month-by-month snapshots (own brand and top competitors per month).
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": {
"project_id": "<project_id>"
},
"name": "get-competitors"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows per page for ranking (default 15, max 50) or months for history (default 12). | |
| offset | No | Rows to skip in the ranking. Use with has_more. | |
| period | No | Report period anchored to the latest check. Default last_30_days. | |
| dataset | No | ranking (default), detail (one brand, needs competitor), history (monthly snapshots). | |
| market_id | No | Projects with several markets (country + language): narrow to one market, id from the markets list of list-projects or get-project-summary. Default: every market combined. | |
| competitor | No | Brand name or fragment for dataset=detail, e.g. "otterly". | |
| project_id | Yes | The AI Visibility project ID returned by list-projects. | |
| include_highlights | No | Include per-platform highlight sentences in the ranking. Default true. | |
| highlights_per_platform | No | Highlights per platform in the ranking, 0-5. Default 3. |