Get a backlinks report
get_backlinks_reportBuys one Backlinks report for a domain or page: best_pages (up to 100 of a domain's pages with the most linking sites, with titles) or referring_networks (up to 100 IP addresses or subnets its links come from). Estimated price: up to ~$0.06 a report, one backlinks request billed by the rows returned. A report saved within 6 hours is read free, and it opens free on the Backlinks page's tab of the same name. For the sites whose links overlap a domain's, use find_link_competitors. 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>",
"report": "<report>"
},
"name": "get_backlinks_report"
}
}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. | |
| report | Yes | best_pages: the target's pages with the most linking sites (a whole domain only). referring_networks: the IP addresses or subnets its links come from. | |
| target | Yes | Domain or URL, e.g. 'example.com'. | |
| network | No | referring_networks only: subnet (default) or ip. | subnet |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | No | ||
| meta | No | ||
| rows | No | ||
| report | No | ||
| target | No | ||
| savedResultId | No |