Skip to main content
Domains are the primary organizational unit in Rankahead. Every prompt, content piece, and visibility metric is scoped to a domain. The domain tools let you list and inspect your tracked domains, manage the competitors you measure against, and add new domains or competitors — optionally triggering a homepage scrape to populate metadata automatically.

​
list_domains

Returns all domains currently tracked in your account, including scrape status and associated entity counts (prompts, competitors, blog posts). This tool takes no input parameters. 
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "list_domains",
    "arguments": {}
  },
  "id": 1
}
​
domains
object[]
Array of domain objects, each containing the domain ID, name, website URL, scrape status, and entity counts.
​
domains[].domainId
string
Unique identifier for the domain.
​
domains[].scrapeStatus
string
Status of the last homepage scrape: PENDING, COMPLETE, or FAILED.

​
get_domain

Returns full details for a single tracked domain, including scraped metadata such as page title, meta description, and detected brand signals.
​
domainId
string
required
The ID of the domain to retrieve.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "get_domain",
    "arguments": {
      "domainId": "dom_01j9z3k8p4c2x"
    }
  },
  "id": 2
}
​
domainId
string
Unique identifier for the domain.
​
name
string
Display name of the domain.
​
website
string
The tracked website URL.
​
metadata
object
Scraped homepage metadata including page title, meta description, and other detected signals.

​
list_competitors

Returns all tracked competitors. You can optionally scope results to a specific domain if you track multiple brands.
​
domainId
string
Optional domain ID to filter competitors to a specific tracked domain.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "list_competitors",
    "arguments": {}
  },
  "id": 3
}

​
get_competitor

Returns full details for a single tracked competitor, including their scraped homepage metadata if a website was provided when the competitor was added.
​
competitorId
string
required
The ID of the competitor to retrieve.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "get_competitor",
    "arguments": {
      "competitorId": "cmp_03mbn4s2o8ez"
    }
  },
  "id": 5
}
​
competitorId
string
Unique identifier for the competitor.
​
name
string
Display name of the competitor.
​
website
string
The competitor’s website URL, if provided.
​
metadata
object
Scraped homepage metadata, populated if a website URL was supplied during creation.

​
add_competitor

Adds a new competitor to a tracked domain. If you provide a website URL, Rankahead will scrape the homepage asynchronously to populate metadata.
​
domainId
string
required
The ID of the domain this competitor belongs to.
​
name
string
required
Display name of the competitor (e.g. “Rival CRM”).
​
website
string
The competitor’s website URL. If provided, a homepage scrape is triggered automatically.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "add_competitor",
    "arguments": {
      "domainId": "dom_01j9z3k8p4c2x",
      "name": "Rival CRM"
    }
  },
  "id": 6
}

​
create_domain

Adds a new domain to your Rankahead account. If you provide a website URL, a homepage scrape is triggered asynchronously to populate brand metadata.
​
name
string
required
Display name for the domain (e.g. “Acme CRM”).
​
website
string
The domain’s website URL. If provided, a homepage scrape is triggered automatically.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "create_domain",
    "arguments": {
      "name": "Acme CRM"
    }
  },
  "id": 8
}
​
domainId
string
Unique identifier for the newly created domain.

​
delete_competitor

Permanently removes a competitor from your account. This action cannot be undone and will remove the competitor from all historical comparisons.
​
competitorId
string
required
The ID of the competitor to delete.
Competitor deletion is permanent. All share-of-voice comparisons and historical data for this competitor will be removed.
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "delete_competitor",
    "arguments": {
      "competitorId": "cmp_03mbn4s2o8ez"
    }
  },
  "id": 10
}