Get a backlinks overview
get_backlinks_overviewReturns a backlinks profile summary (total backlinks, referring domains, domain rank, spam scores, 12 months of trends) and the top referring domains, each with the rank its links pass to the target (sitewide links inflate it). Ranks and spam scores are 0 to 100 scores, not Google metrics. Estimated price: ~$0.16 for a domain (three Backlinks API calls: totals, 12 months of trends, 100 referring domains), ~$0.10 without the referring domains, ~$0.11 for a single page. These are the Backlinks page's own purchases: what is bought here opens free there, and what it holds is answered here at no charge while it is current. Bare domains default to scope 'subdomains'; pass scope 'domain' to exclude subdomains from the totals. Targets with a path default to 'subfolder', whose counts come from filtered backlink totals (no rank, trends or referring-domain breakdown). Trend data always includes subdomains (provider limitation). Each call may spend up to the workspace's agent spend limit ($2.00 unless changed in Settings) without asking: it holds at most its estimate plus a margin while it runs and is charged what it bought, never more. A call whose maximum is above the limit is refused before anything is bought, with its estimate and maximum: ask the user, then call again with approvedMaxCostUsd set to the amount they approved.
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": {
"projectId": "<projectId>",
"target": "<target>"
},
"name": "get_backlinks_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Which part of the site to research. One of: exact_url (a single page), subfolder (the path and everything under it), domain (the hostname without subdomains), subdomains (the hostname plus all of its subdomains). Defaults to subdomains for a bare domain and to subfolder when the input includes a path. The earlier name "page" is deprecated; it is read as exact_url. Subfolder counts are derived from filtered backlink totals, so rank, trends and the referring domains breakdown are unavailable for a subfolder. | |
| target | Yes | Domain or URL to analyze (e.g. 'example.com' or 'https://example.com/blog'). | |
| hideSpam | No | Leave out referring domains whose links' average spam score is above 60, its high band. A spam score is an estimate, not Google's. Defaults to false, as the Backlinks page does, so the domains bought here open free there. | |
| projectId | Yes | Required. The Visibility Genies project this call works in and is billed to. Call list_projects to find one. | |
| approvedMaxCostUsd | No | The most, in USD, the user approved for this call after seeing its estimate and maximum. Only needed after a call was refused for costing more than the workspace's agent spend limit; never set it without asking the user. | |
| includeReferringDomains | No | Also buy the 100 referring domains with the most backlinks. Defaults to true; subfolders have no breakdown. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | No | ||
| meta | No | ||
| scope | Yes | ||
| target | Yes | ||
| overview | Yes | ||
| scopeNote | No | ||
| savedResultId | No | ||
| referringDomains | No |