Keyword battleground (head-to-head)
get_keyword_battlegroundA strictly pairwise head-to-head between your domain and one rival: keyword intersection with both positions, plus the gap list.
The gap list is keywords the rival ranks for that you don't — your publish/target list. Provide domain_a, or project_id to use your project domain. May use lookups; this is strictly pairwise, so call it once per rival. Legacy KR add-on accounts are charged a daily research credit per call even on cache hits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain_a | No | Your domain; defaults to the project domain when project_id is given | |
| domain_b | Yes | The rival domain to compare against, e.g. rival.com | |
| project_id | No | Your ranking id from list_projects — used to resolve your domain (provide domain_a OR project_id). | |
| language_code | No | en | |
| location_code | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | ||
| notes | Yes | ||
| verdict | Yes | ||
| domain_a | Yes | ||
| domain_b | Yes | ||
| gap_list | Yes | ||
| overlap_count | Yes | ||
| lookups_remaining | Yes |